home *** CD-ROM | disk | FTP | other *** search
/ System Booster / System Booster.iso / Commodities / KCommodity / Docs / ASCII / english / KCXDOC.lha / KCommodity.Man < prev   
Encoding:
Text File  |  1993-06-04  |  104.0 KB  |  2,982 lines

  1.    Welcome to KCommodity v2.5. So you finally made it into the
  2. documentation.  I hope you like this program as much as I do and many
  3. other users. For any requests and suggestions just contact me under the
  4. address given in that document.
  5.  
  6.    Within this manual I will refer to the original program texts, that
  7. means not to the localized version of KCommodity.
  8.  
  9. KCommodity is © 1991-1993 Kai Iske, ShareWare
  10.  
  11. Amiga is copyrighted by Commodore Business Machines
  12.  
  13. Installer and Installer project icon
  14. (c) Copyright 1991-93 Commodore-Amiga, Inc.  All Rights Reserved.
  15. Reproduced and distributed under license from Commodore.
  16.  
  17. INSTALLER SOFTWARE IS PROVIDED "AS-IS" AND SUBJECT TO CHANGE;
  18. NO WARRANTIES ARE MADE.  ALL USE IS AT YOUR OWN RISK.  NO LIABILITY
  19. OR RESPONSIBILITY IS ASSUMED.
  20.  
  21. ReqTools is Copyright (C) Nico François
  22.  
  23. RCS2HST is Copyright (C) Dirk Federlein
  24.  
  25. Overview
  26. ********
  27.  
  28. Copyright
  29. =========
  30.  
  31.    You are allowed to copy and spread this program but only if you do
  32. not make any commercial profit out of the program itself and all
  33. supported files. The source of KCommodity is considered teachware and
  34. the author claims the right to be the only one to produce and
  35. distribute new versions of KCommodity. Public Domain vendors are not
  36. allowed to sell KCommodity for more than the price of a regular disk,
  37. which should not be higher than 5 Dollars.
  38.  
  39.    If you do not have the sourcecode yet, you may send me a disk
  40. (including appropriate stamps/money for postage and packing). I will
  41. copy the sourcecode on that disk and return it to you.
  42.  
  43. Guarantee
  44. =========
  45.  
  46.    The author does not give any guarantee that the program KCommodity
  47. works perfectly.  The program was tested and it is used every day,
  48. anyway nobody is perfect and that is why I can not take the
  49. responsibilty for any damages occured during the usage of KCommodity.
  50.  
  51. Evolution
  52. =========
  53.  
  54.    KCommodity was developed out of the need to reduce the amount of
  55. smaller programs, which should ease the daily work with the computer.
  56. Instead I wanted to create an effecient program, which should implement
  57. the functions of these utilities and that my program might go one step
  58. further. At first KCommodity only consisted of a window activator,
  59. which gave me the possibility to activate windows via keystroke or via
  60. mouse movement. Growing knowledge of the new Operating System and the
  61. eagerness to minimize the number of running utilities there were more
  62. functions to be implemented into KCommodity. So KCommodity became
  63. bigger and bigger but it`s size, in comparison to it`s functions, was
  64. held small.
  65.  
  66.    Now I`ve come to a point that KCommodity almost completely suits my
  67. needs and that it replaces other programs of it`s kind. I hope that you
  68. like the supported functions as much as I do and I wait for any
  69. suggestions to implement new, powerful functions.
  70.  
  71. Introduction on KCommodity v2.5
  72. ===============================
  73.  
  74.    KCommodity v2.5 comes as three files (well, there are 4 files, but
  75. the last one is a shared library, which can not be launched by the
  76. user). The first program KCommodity (per default located within
  77. `SYS:WBStartUp/') is the main part. This program controls all the
  78. functions available.
  79.  
  80.    The second program is the Preferences editor also called KCommodity,
  81. which is located within `SYS:Prefs/'. This program can be launched
  82. without having to run the main KCommodity first. It is the interface to
  83. KCommodity for setting all the preferences you like. If you start the
  84. Preferences editor, you will not see any changes made, while KCommodity
  85. itself is not running. All you can do is to change your preferences.
  86.  
  87.    The third program is called `KCXPrinter' and is normaly located in
  88. `SYS:Utilities/'. This program is KCommodity`s printer driver for
  89. dumping screens/windows to a suited printer or to an IFF-ILBM file. It
  90. can only be launched, when the main program is running. If not the
  91. printer driver will tell you and the program will terminate.
  92.  
  93. Notes for updating users
  94. ========================
  95.  
  96.    The preferences file changed again for that release. Please use the
  97. supplied program `PrefsConvert' in order to change existing preferences
  98. to suit the new preferences format. Here is an example how to call the
  99. program.
  100.  
  101.                    PrefsConvert ENVARC:KCX/KCX.PRFES
  102.  
  103.    This would convert the existing preferences file within `ENVARC:KCX/'
  104. for the new format.
  105.  
  106. How to obtain updates
  107. =====================
  108.  
  109.    KCommodity will be available on ADS, FRAS, FTP, and Fred Fish disks.
  110. The versions found on these sources are not restricted, these are
  111. complete and fully working versions of KCommodity. If you already
  112. registered yourself for an older version, please send in some money,
  113. covering copying costs and postage and packing. I am not a millionaire
  114. to be able to do updates myself.  I will announce any new versions on
  115. the corresponding networks (Fido, ZNet, Usenet).
  116.  
  117.    To register please fill out the `Register.Txt' form supplied on the
  118. distribution disk and send it to the address given in that document.
  119. Previous users will find out that KCommodity got somehow more expensive
  120. than older versions. This is due to copy costs and postage and packing.
  121. On many regsitrations I was forced to pay some more than the DM 20...
  122.  
  123. How to contact the author
  124. =========================
  125.  
  126.    If you have any questions, suggestions, bug reports or anything else
  127. you want to tell me, you can contact me under one of the addresses.
  128.  
  129.    Either use normal snail mail:
  130.  
  131.      Kai Iske
  132.      Brucknerstrasse 18
  133.      6450 Hanau 1
  134.      Germany
  135.      Tel.: +49-(0)6181-850181
  136.  
  137.    or reach me using electronical mail
  138.  
  139.      USENET:   kai@iske.adsp.sub.org
  140.      FIDO:     Kai Iske, 2:249/40.11
  141.      ZNET:     SNAKE%HTH@AMNET.ZER
  142.  
  143. Whom I must say 'thank you'
  144. ===========================
  145.  
  146.    I would like to thank the following people
  147.  
  148. `Dirk Federlein'
  149.      For betatesting
  150.  
  151. `Michael Herbst'
  152.      For betatesting
  153.  
  154. `Martin Berndt'
  155.      For betatesting and some bytes that were saved, and for the
  156.      TagScreens source
  157.  
  158. `Olaf Barthel'
  159.      Who answered some questions and helped me with some problems
  160.  
  161. `Frank Mariak'
  162.      For betatesting and the suggestions for the efficient localization
  163.  
  164. `Christoph Reichert'
  165.      My FIDO-Boss for the support
  166.  
  167. `My girlfriend'
  168.      Who accepts what I`ve done/doing
  169.  
  170. `The translators'
  171.      Benoit Mortier, Ruud van der Veen, Terje Bergstrom, Michael
  172.      Korsback, Juan Gomez, David Santamaria, Wolfgang Paul and Franz
  173.      Hemmer.
  174.  
  175.    ...and all the others I forgot
  176.  
  177. Installing KCommodity
  178. *********************
  179.  
  180.    Here some topics about the installation procedure
  181.  
  182. Installing with Installer
  183. =========================
  184.  
  185.    First, simply double-click on the `Install-KCommdodity' icon. You
  186. will have to place Commodore`s Installer in the `C:' directory. There
  187. is not too much to say about how to install KCommodity using Installer.
  188. Simply follow the steps. Help is available almost everywhere.
  189.  
  190. Using ToolTypes
  191. ===============
  192.  
  193.    KCommodity`s main program knows some ToolTypes which can either be
  194. located within the .info file or may be issued on the command line. The
  195. syntax should be of the form ToolType=Value.  If you start the program
  196. from a command line you can leave out the `=' and replace it by a space.
  197.  
  198.    Here are the ToolTypes the program recognizes.
  199.  
  200. `CX_PRIORITY=n'
  201.      Sets the priority for the program`s section which controls the
  202.      HotKeys.  If you issue a priority > 0 it may be that HotKeys
  203.      initialized by other programs may not be reached anymore if
  204.      KCommodity uses the same.  Default: It`s neutral 0.
  205.  
  206. `CX_POPKEY=s'
  207.      Lets you define a new HotKey for opening KCommodity`s main window.
  208.      The Value for this ToolType will be overridden by the definition
  209.      loaded from the Preferences file.  Default: LCOMMAND HELP.
  210.  
  211. `CX_POPUP=YES|NO'
  212.      You can choose whether the main window should be opened on startup
  213.      or not. Issuing YES will open the window whilst NO will keep it
  214.      away.  Default: YES.
  215.  
  216. `PORTNAME=s'
  217.      You can select a different name for the program`s ARexx-Port.
  218.      Please remember that this name`s length should not exceed 16
  219.      chars. Normally this will be KComm.1.
  220.  
  221. `TOOLPRI=n'
  222.      This one is used to set the priority for the program itself. This
  223.      may be usefull while running other programs of KCommodity`s kind,
  224.      since they might conflict.  Just set the priority to a slightly
  225.      higher value and all the problems should be gone. Default: Again
  226.      the neutral 0.
  227.  
  228. `HANDLERPRI=n'
  229.      This ToolTypes lets you define the priority for the InputHandler.
  230.      This Handler is used to control KCommodity`s functions like window
  231.      activator etc.pp.  If you use other programs like KCommodity it
  232.      may happen that these conflict.  Just supply a higher priority and
  233.      problems should be done. Remember that the minimum priority for
  234.      such a Handler is 51. Default: 55.
  235.  
  236. `SETTINGS=s'
  237.      You can have a different Preferences file to be loaded on startup.
  238.      If KCommodity is not successful in finding the specified file it
  239.      will try to open the default `KCX.PREFS' within the current
  240.      directory. If this attempt also fails it will look for the file
  241.      within `ENV:KCX/'. If that one could not be found, too, KCommodity
  242.      will use it`s built-in defaults.
  243.  
  244. `PREFSPATH=s'
  245.      Per default, the prefs programm of KCommodity will be found in
  246.      `SYS:Prefs/'. If you prefer a different location for that program,
  247.      you have to tell KCommodity to look for it in that place. This is
  248.      done using that ToolType. You have to supply the full path
  249.      including filename.
  250.  
  251. `PRINTERPATH=s'
  252.      Normally, KCommodity will look for the printer driver within
  253.      `SYS:Utilities/'. You can override the default path, using this
  254.      ToolType. You have to supply the complete pathname and filename.
  255.  
  256. `NOICON'
  257.      This simple ToolType tells KCommodity not to generate the AppIcon
  258.      on the Workbench. See AppStuff, for more information on AppIcons
  259.      and AppMenuItems.
  260.  
  261. `NOMENU'
  262.      If do not want to have the AppMenuItem, too, use this ToolType.
  263.      (see AppStuff).
  264.  
  265. `ICONX=n'
  266.      Using this ToolType you may specify the AppIcon`s X-Position.
  267.      Default setting is that the Workbench should find a suitable
  268.      location.
  269.  
  270. `ICONY=n'
  271.      Same as above, with only one exeception. This ToolType controls the
  272.      AppIcon`s Y-Position on the Workbench Screen.
  273.  
  274. `NOREQ'
  275.      Per default, KCommodity will first ask you, whether to quit.
  276.      Setting this ToolType will cause the program not to display the
  277.      requester.
  278.  
  279.    For the prefs program there is a ToolType, too. So here it is:
  280.  
  281. `SETTINGS=s'
  282.      This one has the same function as the main program`s *SETTINGS*
  283.      ToolType.
  284.  
  285. Using Shell parameters
  286. ======================
  287.  
  288.    You can supply parameters to KCommodity`s main program when starting
  289. from a CLI / SHELL.  The name and function of each parameter is the
  290. same as already described in the previous section (see ToolTypes).
  291.  
  292.    For the prefs program there is a parameter, too. See ToolTypes, for
  293. a complete list of available ToolTypes.
  294.  
  295. AppIcon and AppMenuItem
  296. =======================
  297.  
  298.    If not chosen differently, when started, KCommodity will display an
  299. AppIcon on the Workbench screen. This icon does not have anything to do
  300. with *normal* Worbench icons. These stand for programs which can be
  301. started by a double-click on the corresponding icon which is defined
  302. within the program`s .info file. An AppIcon is a so called Applications
  303. Icon. This type of icon is generated by programs from which the user
  304. may communicate with the program. For KCommodity the AppIcon only has
  305. one function: A double-click on the icon will open up the main window.
  306.  
  307.    Furthermore KCommodity will generate an AppMenuItem which is
  308. appended to the *Tools* menu of the Workbench. Each program can add one
  309. (or more) entries to that menu. The method of selecting one of these
  310. entries is the same as for "normal" menus. KCommodity will add a menu
  311. entry called *KCX Preferences* from which you can open the program`s
  312. main window.
  313.  
  314. Starting KCommodity
  315. *******************
  316.  
  317.    KCommodity can be started either from Workbench or from CLI / SHELL.
  318.  
  319.    *NOTE* to users of MagicMenu. Please make sure that you launch Magic
  320. Menu, before KCommodity! While starting it from `WBStartUp' you should
  321. set the STARTPRI ToolType to a somewhat higher value than that of
  322. MagicMenu.  This is because MagicMenu also patches the OpenScreen
  323. functions, which would conflict with KCommodity`s window-reactivation
  324. and screen cycling.
  325.  
  326. Starting from Workbench
  327. =======================
  328.  
  329.    If you start KCommodity from Workbench, you may enter some
  330. preferences into the .info file of the program, which will be loaded on
  331. startup. Within the .info file there should be another ToolType set
  332. except for these discussed before (see ToolTypes). This ToolType will
  333. prevent the Workbench from waiting until KCommodity stops, if the
  334. program was launched during boot time (assuming that the program is
  335. located within the `SYS:WBStartUp' drawer). This ToolType is called
  336. DONOTWAIT.
  337.  
  338. Starting from a CLI / SHELL
  339. ===========================
  340.  
  341.    Of course you can start KCommodity from your CLI / SHELL, but you
  342. have to know that KCommodity does not detach itself from the CLI /
  343. SHELL so you will have to use RUN / RUNBACK(1) to prevent KCommodity
  344. from blocking the environment of your CLI / SHELL.  When you start
  345. KCommodity you can supply the same ToolTypes within the commandline as
  346. described earlier (see ToolTypes).  Instead of using one form for
  347. supplying parameters within the .info file you have two on the
  348. commandline. The first is to have a `=' between the keyword and the
  349. value and the second is to have a space between them. Remember that
  350. parameters which include spaces should be enclosed in brackets.
  351.  
  352.                       e.g. "CX_POPKEY=LALT HELP"
  353.  
  354.                                   or
  355.  
  356.                          CX_POPKEY "LALT HELP"
  357.  
  358.    Additionally you have the possibility to retrieve a little Helptext.
  359. The syntax is as follows:
  360.  
  361.                             KCommodity Help
  362.  
  363.    This command will print out a little table showing all available
  364. ToolTypes. Starting KCommodity like this
  365.  
  366.                              KCommodity ?
  367.  
  368.    will show you a list of all available ToolTypes giving you the
  369. possibility to type in the requested keywords and start the program.
  370.  
  371.    ---------- Footnotes ----------
  372.  
  373.    (1)  The latest version of RunBack can be found on Fred Fish Disk 429
  374.  
  375. The Main Program
  376. ****************
  377.  
  378.    Well, there is not too much to say about the main program. When
  379. launched, it will simply do nothing, except for watching/performing all
  380. the actions specified within the Preferences editor (see PrefsPrg, for
  381. more information about setting the prefs).
  382.  
  383.    On demand KCommodity may also launch the Preferences editor either
  384. via HotKey, AppIcon or via the AppMenuItem (see AppStuff, for more
  385. about that).
  386.  
  387.    Additionally you can launch the Graphics dump by using a HotKey.
  388.  
  389.    There are at least one or two functions/windows which may be opened
  390. by the main program, which are built into this part of KCommodity.
  391.  
  392.    *NOTE* to users of MagicMenu. Please make sure that you launch Magic
  393. Menu, before KCommodity! While starting it from `WBStartUp' you should
  394. set the STARTPRI ToolType to a somewhat higher value than that of
  395. MagicMenu.  This is because MagicMenu also patches the OpenScreen
  396. functions, which would conflict with KCommodity`s window-reactivation
  397. and screen cycling.
  398.  
  399.    Here is a list of functions KCommodity offers per default, which can
  400. not be altered:
  401.  
  402.    - Mapping left Amiga N/M In addition to window-reactivation the keys
  403.      left Amiga in conjunction with M or N are treated somewhat
  404.      special, in order to allow complete window reactivation.
  405.  
  406.    - WildStar KCommodity will automatically set the WildStar bit. This
  407.      means, that you may use the '*' within the Shell as a real
  408.      Wildcard. KCommodity will go one step further by giving you the
  409.      possibility to use the '*' Wildcard alone as a joker for
  410.      "all-files", which can not be done by simply setting a flag.
  411.  
  412.    The windows of KCommodity`s main program are:
  413.  
  414. Formatter
  415. =========
  416.  
  417.    KCommodity has the ability to check every disk inserted whether the
  418. disk is formatted or not. You can tell KCommodity to ask whether the
  419. disk just inserted should be formatted. This is done within the
  420. Formatter window.  KCommodity will recognize all drives connected to
  421. your computer and you can tell the program which disk drives to watch,
  422. that means which drives should be checked for unformatted disks. So if
  423. you insert an unformatted disk into a drive which is checked by
  424. KCommodity, the program will pop up a requester asking whether you wish
  425. to format the disk or not. If you do want to format, this window will
  426. pop up.
  427.  
  428.    Alternatively it can also be opened by using a HotKey (see
  429. Formatter) or by using the gadget within the Preferences editor (see
  430. PrefsPrg).
  431.  
  432.    *NOTE:* Due to the different filesystem, KCommodity will not
  433. recognize MS-DOS disks inserted into a PCx: drive.
  434.  
  435.    Here are the gadgets for this window. Some of them are only
  436. available to the Formatter by Olaf 'Olsen' Barthel (1). These gadgets
  437. will be marked as those only applying to this program.  Additionally
  438. two of the gadgets are only available, when running under OS 3.0. These
  439. gadgets are only accepted by the original Commodore formatter.
  440.  
  441.    *NOTE:* If you supply a flag to a formatter it does not understand,
  442. you will not be able to format any disk!
  443.  
  444.    If you want to make use of KCommodity`s formatting facility, you
  445. have to copy the formatter program to `SYS:System'.
  446.  
  447.    ---------- Footnotes ----------
  448.  
  449.    (1)  Which can be found on Fish Disk 535
  450.  
  451. Drive
  452. -----
  453.  
  454.    This gadget reflects the drive name selected for the format
  455. operation. If the window was opened interactively (say, by KCommodity
  456. after the requester), the program will automatically select the drive
  457. the unformatted disk was inserted in.
  458.  
  459. Label
  460. -----
  461.  
  462.    This one`s simple. This gadget holds the new diskname.
  463.  
  464. Trashcan
  465. --------
  466.  
  467.    This gadget tells the format program to generate the Trashcan on the
  468. disk formatted. This option is available to all of the formatters.
  469.  
  470. Quick
  471. -----
  472.  
  473.    If you want to format an already formatted disk, you may use this
  474. switch to just clear the disk. This option may be used with all
  475. formatters.
  476.  
  477. FFS
  478. ---
  479.  
  480.    Beginning with OS 2.0, floppy disks can be formatted using the
  481. FastFileSystem. This flag tells the formatter to use this filing system
  482. to format the disk. It can be used with all of the programs.
  483.  
  484. Directory-Cache
  485. ---------------
  486.  
  487.    Starting with OS 3.0, there was a new option for the filesystem
  488. called Directory Caching. This will dramatically increase directory
  489. load times, but it can only be used with OS 3.0 and up and that means
  490. it can only be used with the OS 3.0 formatter command.
  491.  
  492. Intern. Mode
  493. ------------
  494.  
  495.    This option is available only under OS 3.0 and up (and for that
  496. formatter program, of course). It is usefull for transfering disks
  497. between different localized systems that means AmigaDOS will correctly
  498. recognize german Umlauts within filenames, so that you do not have to
  499. write them uppercase, if they are uppercase within the name.
  500.  
  501. No Verify
  502. ---------
  503.  
  504.    Using this option you may turn off the verify option of Olaf
  505. Barthel`s formatter. As you can beleive this option only works with
  506. this formatter.  Turning off verify will reduce format time, but you
  507. can never be sure, whether the disk has been formatted correctly.
  508.  
  509. Install
  510. -------
  511.  
  512.    In order to boot from a disk it has to be installed first. Olaf
  513. Barthel`s formatter is able to install a disk, after formatting it. So
  514. simply turn on this gadget to have a bootable disk after formatting. As
  515. said, this option may only be used with Olaf`s formatter.
  516.  
  517. Eject
  518. -----
  519.  
  520.    Some disk drives understand the eject command, which causes the disk
  521. drive to automatically eject the disk. Olaf Barthel`s formatter
  522. supports this flag, in order to minimize user "support". This flag may
  523. only be used with his formatter.
  524.  
  525. Watch disks
  526. -----------
  527.  
  528.    Turning on this gadget will cause KCommodity to watch all selected
  529. disks (see Drives03). If this gadget is turned off, KCommodity will not
  530. bother you with any questions concerning formatting a disk.
  531.  
  532. DF0: - DF3:
  533. -----------
  534.  
  535.    Maybe not all of these gadgets will be available (unghosted). Only
  536. those gadgets are available, which apply to a drive connected to your
  537. system. If one of these gadgets is turned on, KCommodity will check
  538. every disk inserted into that drive (see WatchDisks).
  539.  
  540. Format
  541. ------
  542.  
  543.    Clicking onto this gadget will start the format operation. A small
  544. console window opens up and the formatter will be loaded.
  545.  
  546. Cancel
  547. ------
  548.  
  549.    Simple, cancel the format.
  550.  
  551. Bill window
  552. ===========
  553.  
  554.    This window may either be opened by the Preferences editor (see
  555. PrefsPrg) or by hitting a HotKey (see HotKeyWin).
  556.  
  557.    This window gives you information about the actual / past phone
  558. call. The actual system time *Time*, the online time *Online*, and the
  559. costs arising / arisen from a call *Cost*, will be shown. Underneith
  560. there are five gadgets you can select the time zone and tariff with. If
  561. you change the settings during a phone call KCommodity will
  562. automatically recalculate the costs so that the program *always* works
  563. with the correct values and stores them to the log file. Underneith
  564. these gadgets there is another display box showing the costs for one
  565. hour for the given time zone and tariff. At the bottom border of the
  566. window there is another gadget called *Log call*. If it is activated
  567. data about the current phone call will be written to the log file after
  568. the modem hung up. If the gadget is deselected this data will not be
  569. stored to the file. This data will be used by * Display total sum* (see
  570. BillPrefs, for more about this) to calculate the total costs for all of
  571. your phone calls. This gadget might be usefull to filter out some
  572. calls, say if you have been called by another person.
  573.  
  574.    This window is equipped with a Zoom Gadget. Using this gadget it is
  575. possible to easily switch between two sizes for the window, so that it
  576. does not use too much space on the Workbench (or the Public Screen).
  577. The window`s position (normal sized or "zoomed") will be written to the
  578. Preferences file. If the window is zoomed (small), the window`s title
  579. bar will show the online time, costs, timezone, tariff, and whether the
  580. call will be logged or not, so that you always have an overview of
  581. data. You can also read, whether data about the call should be saved.
  582.  
  583.    When looking at the window you might recognize two more gadgets
  584. labeled *Start* and *Stop*. These may be used to manually start the cost
  585. calculating, say while you are making a voice call. While you are in
  586. manual mode KCommodity will ignore any Carrier Detects and losses, that
  587. means you may do transmissions and then continue to talk voice. On the
  588. other side, you can not stop cost calculation by using *Stop* if the
  589. calculation was started due to a Carrier Detect.
  590.  
  591. Select screen window
  592. ====================
  593.  
  594.    This window will *only* be opened when you use it`s HotKey.  See
  595. SelScr. The default definition for this HotKey is LSHIFT ESC.
  596.  
  597.    Imagine you have several screens open and wish to get to a specific
  598. screen quickly. Instead of flipping through all the screens manually
  599. you may open the *Select screen* window. Within this window you will
  600. find a list of all available screens currently known to the system.
  601.  
  602.    If you try to open the window, KCommodity will first try to
  603. determine the active screen`s type. If it is a Public screen, the
  604. window will pop up on this one. If not, the default Public screen will
  605. be used and brought to front. If you cancel the operation the
  606. non-public screen will be brought back to front.
  607.  
  608.    Furthermore you will see the number of screens and the name of the
  609. default public screen.
  610.  
  611.    The gadgets within this window are as follows:
  612.  
  613. List
  614. ----
  615.  
  616.    Within this listview gadget you will see a list of all screens
  617. currently open. Public screens will come first, their names will be
  618. preceded by a *(PUB)* string to indicate their type. If KCommodidty can
  619. not determine the name of a screen there will be an entry of *? NO NAME
  620. ?*.
  621.  
  622. Update list
  623. -----------
  624.  
  625.    If you are not sure whether screens have been removed/added to the
  626. system, you may click onto this gadget to tell KCommodity to rescan the
  627. screen list.  The new list will then be shown within the listview
  628. gadget (see SelList).
  629.  
  630. Activate
  631. --------
  632.  
  633.    This gadget will bring the selected screen to front.
  634.  
  635.    *WARNING:* If you try to bring a screen to front which is no longer
  636. opened, the system will crash (I will secure that probably).
  637.  
  638. Cancel
  639. ------
  640.  
  641.    This gadget will simply cancel the operation. If the window was not
  642. opened upon a Public screen, the previous screen will be brought back
  643. to front.
  644.  
  645. The Preferences Program
  646. ***********************
  647.  
  648.    Assuming, that you used the default installation for installing
  649. KCommodity on your HardDisk/BootDisk I will now explain, how to use the
  650. Preferences program to set up KCommodity to your needs. This program
  651. may be started either by KCommodity or by simply double-clicking onto
  652. the icon. Per default the program is located within `SYS:Prefs/'. This
  653. program is the main interface to KCommodity, as it controls all the
  654. settings.
  655.  
  656.    Within the windows you will find gadgets (how come ?). All of the
  657. gadgets may alternatively controlled via keyboard. To find out which
  658. key to use, simply take a look at the gadget`s text. There is a
  659. character underlined, which is the shortcut to use.
  660.  
  661.    The lower 6 gadgets are used to control KCommodity. These are:
  662.  
  663.    - Load Prefs Having selected this gadget, a FileRequester will open
  664.      up asking for a file to load new settings from, which should be
  665.      used by KCommodity from now on.  Using this feature you may store
  666.      several settings to your (Hard)Disk. Have a look at section *Save
  667.      Prefs* to see which data is written to that file.
  668.  
  669.    - Save Prefs As mentioned under *Load Prefs* a FileRequester will
  670.      open up. You can now specify a file the current settings should be
  671.      written to. The following data is written to that file:
  672.  
  673.         * All settings of all windows
  674.  
  675.         * The position / size of all windows
  676.  
  677.    - Remove This gadget will tell KCommodity (the main part) to remove
  678.      itself. This gadget is unavailable if KCommodity does not reside
  679.      in memory.
  680.  
  681.    - Enable Clicking onto this gadget will invert the status after
  682.      *Disable*. All of the program`s functions will be reenabled.
  683.  
  684.    - Disable Selecting this gadget will turn off almost all of the
  685.      program`s functions.  Touched are the following features:
  686.  
  687.         * MMB-Shift
  688.  
  689.         * Map "Umlauts"
  690.  
  691.         * MenuWrap
  692.  
  693.         * String2Menu
  694.  
  695.         * KeyStroke clicker
  696.  
  697.         * ESC Window Close
  698.  
  699.         * Full dragging
  700.  
  701.         * Enter ASCII
  702.  
  703.         * Screen / mouse blanker
  704.  
  705.         * The screen / window cycling
  706.  
  707.         * The window activator
  708.  
  709.         * The mouse accelerator
  710.  
  711.         * LeftyMouse
  712.  
  713.         * Mouse locking
  714.  
  715.         * The function keys
  716.  
  717.         * *All* HotKeys
  718.  
  719.      Please remember that KCommodity`s windows can not be opened via
  720.      HotKeys anymore. You will have to use either the AppIcon,
  721.      AppMenuItem or use the Exchange program to open the program`s main
  722.      window and from there you can open the other windows. Of course
  723.      you can reenable KCommodity using the Exchange program.
  724.  
  725.    - Quit Will quit the Preferences Editor
  726.  
  727.    The main window has a menu attached.
  728.  
  729.    * Save settings...  Will save the current settings under the name
  730.      last used, without opening a FileRequester.
  731.  
  732.    * About...  Will open the About-Requester.
  733.  
  734.    The upper 15 gadgets lead to windows which will be described now:
  735.  
  736. The settings window
  737. ===================
  738.  
  739.    This window only controls simple functions, which do not require any
  740. further input. You can just turn on/off some features of KCommodity
  741. here.
  742.  
  743.    Here are the features you can control through the Settings window
  744.  
  745. MMB-Shift
  746. ---------
  747.  
  748.    Is abbreviation for "Middle-Mouse-Button Shift". This feature aids
  749. you in multiselecting icons on the Workbench. While you are
  750. multiselecting there is no need to press the SHIFT key anymore, simply
  751. hit your middle mousebutton.
  752.  
  753. Write environment
  754. -----------------
  755.  
  756.    If you want to offer the current system time to another application,
  757. which does not supply a time display, but is able to read environment
  758. variables then you can tell KCommodity to generate environment
  759. variables for you, which contain the actual system time and date.
  760.  
  761.    This gadget de- / activates the creation of environment variables
  762. for the actual system date. Variables will be generated for the day,
  763. date, and time.  These variables take the names DAY, DATE, and TIME.
  764.  
  765. Map "Umlauts"
  766. -------------
  767.  
  768.    With a selected gadget all Umlauts will be automatically mapped to
  769. their pendants (ae, oe, ue). Of course this function works
  770. case-sensitive, so that KCommodity will generate Ae, Oe, and Ue if one
  771. of the keys was hit in conjunction with SHIFT. The `SZ' will be mapped,
  772. too, so that there may not be any problems anymore in writing German
  773. texts not containing German Umlauts.
  774.  
  775. Drive NoClick
  776. -------------
  777.  
  778.    Using this gadget you may turn on / off the noisy drive-clicking.
  779.  
  780. WB to front
  781. -----------
  782.  
  783.    If this gadget is set, the Workbench screen will be brought to front
  784. if you try to open KCommodity`s main window.
  785.  
  786. MenuWrap
  787. --------
  788.  
  789.    This gadget controls the MenuWrap feature of KCommodity. If the
  790. gadget is set, and you try to access a window`s menu, the mouse pointer
  791. will immediately jump into the menubar. When you are moving through the
  792. menu and hit one of the menu`s horizontal borders, the mouse will
  793. automatically jump to the other side of the menu, keeping it within the
  794. menu boundaries. This function does not affect the vertical movement of
  795. the mouse.
  796.  
  797.    *NOTE:* MagicMenu does something strange when doing it`s menu
  798. thingies. I was not able to get this function to work with MagicMenu.
  799.  
  800. No DisplayBeep
  801. --------------
  802.  
  803.    This gadget toggles the Intuition function DisplayBeep(). When
  804. turned on, KCommodity will prevent any function from calling
  805. DisplayBeep(), in order to turn off any annoying sounds or flashes.
  806.  
  807. Avoid Flicker
  808. -------------
  809.  
  810.    This gadget may be of use for users of a Commodore FlickerFixer or
  811. an Amiga 3000. This FlickerFixer creates a flickering first line on the
  812. monitor.  Using this feature you are able to turn off this flickering.
  813. One note to users of this function: You can not move a screen to
  814. vertical position 0 anymore. Otherwise the screen would be completely
  815. black.
  816.  
  817. String2Menu
  818. -----------
  819.  
  820.    Previous users of OS 1.3 may still remember the ability to reach menu
  821. shortcuts from within String Gadgets of a e.g. CygnusED window (like
  822. the Search Requester). Under OS 2.0 this has changed. There was no way
  823. to use this nice feature anymore. This changes, when you turn on
  824. String2Menu and back are the good old times. From any String Gadget in
  825. any window you may now reach a window`s menu via it`s shortcuts.
  826.  
  827. Miscellaneous window
  828. ====================
  829.  
  830.    Within this window you will find settings which require more
  831. specific inputs.
  832.  
  833. Key-Click
  834. ---------
  835.  
  836.    You probably know this feature from professional keyboards. These
  837. keyboards produce a clicking sound when a key is hit. This feature is
  838. simulated by KCommodity.  You can set the volume for producing the
  839. sound to have an acceptable simulation.
  840.  
  841.    This gadget is used to de- / activate this feature.
  842.  
  843. Click volume
  844. ------------
  845.  
  846.    Using this gadget you can alter the volume for the clicking sound of
  847. KeyClick. Values between 1 and 64 are accepted.  Remember that 1 is the
  848. lowest volume and 64 is the highest.
  849.  
  850. ESC WindowClose
  851. ---------------
  852.  
  853.    This gadget de- / activates the emulation of the beloved function of
  854. good PC programs. A hit on the ESC key in conjunction with a qualifier
  855. defined by ESC Qualifier will close the window underneith the mouse.
  856. (see ESCCloseQual, for more information) Prerequisits for this function
  857. are that the window does not show a requester and that a Close Gadget
  858. is tied to the window.
  859.  
  860. ESC Qualifier
  861. -------------
  862.  
  863.    To the right of this gadget you find the shortcut definition which
  864. activates the ESC Window Close function. (see ESCWindowClose, for
  865. information about that feature) If you want to change the shortcut,
  866. simply hit on that gadget. A window will pop up giving you the
  867. possibility to change the key-combination. Simply hit the keys you want
  868. to use in conjunction with ESCAPE. If you click on OK the definition
  869. will be in use. Please remember that you have to click underneith the
  870. Text Gadget, otherwise the left mousebutton will not be recognized.
  871.  
  872. Full drag
  873. ---------
  874.  
  875.    Using KCommodity there is no need to click on a window`s titlebar in
  876. order to move that window. Just click inside the window and perform the
  877. movement as if you clicked on the titlebar.
  878.  
  879.    This gadget controls the Full-Drag function. The qualifier defined
  880. under Dragging Qualifier will not be checked if this gadget is not
  881. selected.  See DragQual, for more information about defining it`s key.
  882.  
  883. Dragging qualifier
  884. ------------------
  885.  
  886.    As with ESC Qualifier you can define the qualifier for the Full Drag
  887. function (see FullDrag). If you hit this qualifier in conjunction with
  888. the left mousebutton you can move a window without having to click onto
  889. the window`s titlebar.
  890.  
  891. User-Shell command
  892. ------------------
  893.  
  894.    You can enter a command string for a Shell command here. This
  895. command will be executed, if you hit the appropriate HotKey. Just enter
  896. a command with it`s parameter here as if typed into a CLI / SHELL. Here
  897. is a small example:
  898.  
  899.                      NewSHELL CON:0/11//200/Shell
  900.  
  901.    would start a new Shell process. It`s window would be 200 pixels
  902. high and it would be positioned underneith the Workbench`s titlebar.
  903.  
  904.    Remember that you enclose the 'CON:...' string in quotes, if it
  905. contains any blanks. Just like you would do it from a CLI / SHELL.
  906.  
  907.    The Shell will be launched when you hit the appropriate HotKey. The
  908. default definition for this HotKey is ALT SHIFT S. See UserShellKey,
  909. for more information.
  910.  
  911. Enter ASCII
  912. -----------
  913.  
  914.    This is a nice feature for users, who can remember ASCII codes of all
  915. characters available on the Amiga. Just like on PCs you can enter a
  916. character, by entering it`s ASCII code on the numeric keypad, while
  917. holding down the LEFT ALT key. In KCommodity you can change the
  918. qualifier for use with Enter ASCII. This is done with the ASCII
  919. Qualifier gadget.  (see ASCIIQual).
  920.  
  921. ASCII Qualifier
  922. ---------------
  923.  
  924.    This gadget is used to set the qualifier to be hit in order to enter
  925. a character`s ASCII code (see EnterASCII). You can either use the LEFT
  926. ALT key or the CONTROL key. Simply click on the gadget and it will
  927. change it`s state.
  928.  
  929. Exploding windows
  930. -----------------
  931.  
  932.    This is more a hack than a "useful" feature. With an active Exploding
  933. Windows function on opening a window frames will be drawed from the
  934. center of the screen to the window`s new position. It seems like the
  935. window is smoothly growing to it`s full size. When closing the window
  936. the motion will go the other way around. First the window will be
  937. closed and then the frames will be drawed back to the center of the
  938. screen. This function does not have any effect on backdrop windows. It
  939. does not have to be the screen`s center. Alternatively you can tell
  940. KCommodity to use the actual mouse position as the animation`s focus.
  941. Additionally there is another feature. If you move a window, size it or
  942. "zoom" it, frames will be drawed from the window`s current position to
  943. the new one, that means the metamorphosis will be shown.  To shorten
  944. the time for exploding / imploding the frames on "slow" Amigas you have
  945. the possibility to set the number of frames to be drawed for exploding,
  946. imploding and sizing / moving / zooming.
  947.  
  948. From/To mouse
  949. -------------
  950.  
  951.    This gadget controls the focus of the Exploding Windows animation. If
  952. selected, frames will be drawed from the current mouse position instead
  953. of the screen`s center.
  954.  
  955. Explode frames
  956. --------------
  957.  
  958.    As mentioned you can define the number of frames to be drawed for
  959. exploding / imploding animations for an active Exploding Windows
  960. function.  Frames in the means of a number of rectangles to be drawed
  961. until the complete size of the window is reached. This gives users of
  962. "slower" computers the possibility to use the Exploding Windows
  963. function because they can find values which do not slow down their
  964. machine a lot. This gadget defines the number of frames to be drawed
  965. when opening a window. The value can range from 0 to 64 frames, where 0
  966. means that no frames will be drawed for that animation.
  967.  
  968. Implode frames
  969. --------------
  970.  
  971.    As mentioned above you can select a number of frames here. This time
  972. it is the number of frames to be drawed when closing a window. See
  973. ExpFrames, for more information about frame settings.
  974.  
  975. Size frames
  976. -----------
  977.  
  978.    Using this gadget you can set the number of frames to be drawed when
  979. resizing a window (see ExpFrames).
  980.  
  981. Move frames
  982. -----------
  983.  
  984.    As with Size frames you control the number of frames for resizing,
  985. you can change the number of frames for moving a window using this
  986. gadget.  (again see ExpFrames).
  987.  
  988. Clock definitions window
  989. ========================
  990.  
  991.    Within this window you find gadgets to control the behaviour and
  992. style of the clock/memory display. This display can either be shown in
  993. the upper right corner of the Workbench screen, or it may be displayed
  994. in a normal window, which can be moved around on the Workbench screen.
  995. You have the possibility to choose from different display styles and
  996. formats with different information. Here is a list of available "pages".
  997.  
  998.   1. Time/Date display (maybe with mouse coordinates)
  999.  
  1000.   2. Memory page, showing chip and fast memory seperately
  1001.  
  1002.   3. Memory page, showing total amount of free memory
  1003.  
  1004.   4. Time/Date display combined with memory display
  1005.  
  1006.   5. Graphical display of available memory. (Gauge shown)
  1007.  
  1008.   6. Online time, means connect time to a BBS
  1009.  
  1010.    Here are the gadgets which control the format and look of the
  1011. clock/memory display. Per default only page 1 will be visible. Refer to
  1012. HotKeyWin for more information on how to reach the displays.
  1013.  
  1014. Display clock/mem
  1015. -----------------
  1016.  
  1017.    You can turn off the displaying of clock/memory informations using
  1018. this gadget.  The display will disappear from the Workbench titlebar or
  1019. the window will be closed, if you turn off this gadget.
  1020.  
  1021. Display in window
  1022. -----------------
  1023.  
  1024.    If you prefer to have the display within the titlebar of a small
  1025. window, which can be dragged around the Workbench screen, simply turn
  1026. this gadget on. The display within the Workbench`s titlebar will
  1027. disappear and the window will pop up. This gadget has no effect if you
  1028. turned off Display clock/mem (see DispClock).
  1029.  
  1030. Show time
  1031. ---------
  1032.  
  1033.    If you do not want to have the time displayed, then you should
  1034. simply turn off this gadget.
  1035.  
  1036. Show day
  1037. --------
  1038.  
  1039.    You can disable the displaying of the current day using this gadget.
  1040.  
  1041. Show seconds
  1042. ------------
  1043.  
  1044.    If the seconds display gets too annoying, then you can disable the
  1045. seconds using this gadget.
  1046.  
  1047. Short day string
  1048. ----------------
  1049.  
  1050.    If you believe the day names to be too long for your needs, you may
  1051. turn on this gadget, in order to get three char day names.
  1052.  
  1053. Show date
  1054. ---------
  1055.  
  1056.    You can tell KCommodity to display the current date within the
  1057. Workbench`s titlebar or within the window`s titlebar.
  1058.  
  1059. Show mouse X/Y
  1060. --------------
  1061.  
  1062.    Sometimes you might like to know, where the mouse is positioned at.
  1063. This function will print out the current mouse position in the
  1064. clock/memory display. *WARNING*: This function is very CPU-time
  1065. consuming. If you rapidly move the mouse KCommodity will have to update
  1066. the display every move it detects.
  1067.  
  1068. Date Format
  1069. -----------
  1070.  
  1071.    If you do not like the default date format KCommodity offers. You
  1072. may choose between six different styles. These are:
  1073.  
  1074.    - MM-DD-YY
  1075.  
  1076.    - DD-MM-YY
  1077.  
  1078.    - MM.DD.YY
  1079.  
  1080.    - DD.MM.YY
  1081.  
  1082.    - DD-MMM-YY
  1083.  
  1084.    - DD.MMM.YY
  1085.  
  1086.    The latter two will show the month name in an abbreviated form (only
  1087. three chars).
  1088.  
  1089. Text front
  1090. ----------
  1091.  
  1092.    You can select a new color for the clock/memory display, if you do
  1093. not like the default colors KCommodity chooses (depending on which
  1094. version of the OS you are running). This setting will only affect the
  1095. colors in which the text will be drawed.
  1096.  
  1097. Text back
  1098. ---------
  1099.  
  1100.    This gadget will have a similar effect on the clock/memory display as
  1101. TextFront. It will change the text`s background color.
  1102.  
  1103. Gauge front
  1104. -----------
  1105.  
  1106.    As mentioned above KCommodity offers a page for a graphical memory
  1107. display.  This page will show a gauge giving you an overview of
  1108. available memory. If you do not like the colors used to render the
  1109. gauge, you may use this gadget, in order to change the gauge`s front
  1110. color. You may also change the gauges back color using GaugeBack.
  1111.  
  1112. Gauge back
  1113. ----------
  1114.  
  1115.    As already explained you may change the gauge`s colors. This gadget
  1116. is used to change the gauge`s background color. Refer to GaugeFront to
  1117. learn how to change the front pen.
  1118.  
  1119. Blanking
  1120. ========
  1121.  
  1122.    KCommodity can blank the screen and mouse for you. For blanking the
  1123. screen, there are two possibilities. The first is to completely blank
  1124. the screen, say it will be dark black, or to dimm the screen by a given
  1125. factor. The mouse may either be blanked after a given timeout and/or it
  1126. might immediately blank, when a key is hit.
  1127.  
  1128.    *Note* that KCommodity`s mouse blanker is as systemfriendly as
  1129. possible, that means the mouse will *unblank* when an application tries
  1130. to change the mouse image or when it opens a window. KCommodity will
  1131. then reblank the mouse in at least one second. This might lead to a
  1132. flickering, when the pointer is changed rapidly, so some users might
  1133. find that one annoying, but I prefer a systemfriendly solution, than a
  1134. non-stable one, which looks nice.
  1135.  
  1136.    KCommodity`s blanker does not have any of these graphical things. I
  1137. think that there are enough good blankers of this kind out there and
  1138. Spliner is a very good piece of programmer`s art. I do not think that
  1139. it is worth the time to try to copy this program.
  1140.  
  1141.    Enough of technical talk, let`s come to the gadgets which control the
  1142. blanking.
  1143.  
  1144. Blank mouse on keystroke
  1145. ------------------------
  1146.  
  1147.    If this gadget is active, the mouse will be blanked on every
  1148. keystroke. If not, the mouse will stay as it is, when you are typing
  1149. something on the keyboard.
  1150.  
  1151. Screen time
  1152. -----------
  1153.  
  1154.    This slider gadget is used to select the time KCommodity should wait
  1155. before blanking the Screen. The countdown will always be restarted if
  1156. the mouse is moved, if a key is pressed, if a disk is inserted/removed,
  1157. the joystick is used, or a requester pops up. An input of 0 turns off
  1158. the Screen Blanker/Dimmer.
  1159.  
  1160. Mouse time
  1161. ----------
  1162.  
  1163.    As mentioned under ScreenTime you can enter the amount of seconds
  1164. before blanking the mouse here. Again, if you enter 0 the MouseBlanker
  1165. will be turned off.
  1166.  
  1167.    *Note* the restrictions on the mouse blanker mentioned in the
  1168. introduction.
  1169.  
  1170. Blanker type
  1171. ------------
  1172.  
  1173.    This gadget is used to determine the type of screen blanking.  If
  1174. *Blanker* is shown the blanker acts as intended. KCommodity will
  1175. completely blank the screen after the time has elapsed (see
  1176. ScreenTime). If this gadget reads *Dimmer* KCommodity will dimm the
  1177. screen with the given factor. Refer to DimmFactor for more information
  1178. on setting the dimm factor.
  1179.  
  1180. Dimm factor
  1181. -----------
  1182.  
  1183.    This gadget is only active if *Blanker Type* is set to * Dimmer* (it
  1184. is not ghosted) (refer to BlankerType, for more information about
  1185. that). You can now define the factor for dimming the screen. The
  1186. settings can range from 1 to 48 where 1 is the brightest and 48 the
  1187. darkest. Just look for the factor which suits your needs. As the
  1188. dimming is done that way, as it subtracts 1 from each color value until
  1189. the factor is exceeded, minor color "changes" may occure. If you prefer
  1190. to have the real colors after dimming then just enter a value which is
  1191. a multiple of 3.
  1192.  
  1193. Cycle settings
  1194. ==============
  1195.  
  1196.    KCommodity offers the possibility to easily flip through screens and
  1197. windows. This can either be achieved by using the mouse or by defining
  1198. key-combinations to do the cyclings. Within this window you may change
  1199. the number of clicks needed to initiate the wanted action and to change
  1200. the keys needed to do it.
  1201.  
  1202.    Cycling through windows is done by clicking onto a window with the
  1203. given key-combinations. If you want to cycle through screens, then
  1204. simply click on a backdrop window or the screen itself.
  1205.  
  1206. Cycling enabled
  1207. ---------------
  1208.  
  1209.    Using this gadget you may tell KCommodity not to watch the
  1210. key-combinations for screen / window cycling. Turning off this gadget,
  1211. no more cycling can be performed.
  1212.  
  1213. Front clicks
  1214. ------------
  1215.  
  1216.    This slider gadget determines the number of clicks to occure before a
  1217. window/screen to front is to be executed. You can choose from 1 to 5
  1218. clicks. These clicks have to occure within the *Double-Click* time.
  1219.  
  1220. Middle clicks
  1221. -------------
  1222.  
  1223.    You can define the number of clicks for the middle mousebutton (in
  1224. conjunction with the key-combination), after which should a screen
  1225. cycling should be executed.
  1226.  
  1227. Back clicks
  1228. -----------
  1229.  
  1230.    This gadget is to be used to determine the number of clicks to be
  1231. made, in order to execute a screen/window to back.
  1232.  
  1233. Front key
  1234. ---------
  1235.  
  1236.    Click on this gadget to define a new qualifier for performing a
  1237. screen/window to front action. To the right of this gadget you will
  1238. find the current qualifier. Have a look at QualWin, to learn how to use
  1239. that window for defining a new qualifier.
  1240.  
  1241. Middle Key
  1242. ----------
  1243.  
  1244.    This gadget lets you define a new qualifier to be used in
  1245. conjunction with the middle mouse button for flipping through screens.
  1246. When defining a new qualifier (see QualWin), you can only change the
  1247. qualifier itself, not the key to be used (that means the middle mouse
  1248. button).
  1249.  
  1250. Back Key
  1251. --------
  1252.  
  1253.    As easy as you can pop screens/windows to front, you may push them
  1254. to back using the key-combination shown to the right of this gadget.
  1255. Clicking onto this gadget will bring up the QualWin, allowing you to
  1256. change the combination for pushing screens/windows to back.
  1257.  
  1258. Tag Screens
  1259. ===========
  1260.  
  1261.    Some of you might know TagScreens by Martin Berndt. Thanks to him I
  1262. implemented the complete TagScreens v1.8 source into KCommodity, and I
  1263. added some new features and functions to the existing. TagScreens v1.8
  1264. only handeled old OS 1.3 screens and patched them for newlook OS 2.x
  1265. screens.  KCommodity goes one step further. It not only patches all
  1266. screens, it will give you the possibility to do by-task patches, that
  1267. means you can easily patch PageStream to use a A2024 display.
  1268. Additionally you may have the patched screens to be auto-centered, if
  1269. not opened with full width.  The AutoScroll bit may be set for a screen
  1270. and the DrawPens may be selected for the screen to be opened, so that
  1271. the screen will appear in the new look.
  1272.  
  1273.    Owners of a ECS-Denise may have the Genlock border blanked, so that
  1274. there is no unused space on the left and right borders of the screen.
  1275. KCommodity will turn that border black.
  1276.  
  1277.    Users of OS 3.0 may have the screens patched to use interleaved
  1278. BitMaps to increase display update, or to clone the Workbench
  1279. dimensions and depth by setting one single flag.
  1280.  
  1281.    So here are the gadget to control the extended Tag Screens features
  1282. of KCommodity.
  1283.  
  1284. TagScreens activated
  1285. --------------------
  1286.  
  1287.    This gadget simply turns on/off TagScreens. When the gadget is
  1288. active, KCommodity will watch all screens to be opened, in order to
  1289. patch them.
  1290.  
  1291. Task list
  1292. ---------
  1293.  
  1294.    Within this gadget you will see a list of tasks to be watched. All
  1295. screens of tasks listed here will be patched to the settings made for
  1296. them. You might see an entry called "*** GLOBAL TAG ***" which is
  1297. responsible for all tasks not listed.
  1298.  
  1299. Task name
  1300. ---------
  1301.  
  1302.    For a selected entry (except for the GLOBAL TAG), you may change the
  1303. name for the task to be watched. You do not have to worry about the
  1304. case of the name you enter. KCommodity will check the tasks name
  1305. case-insensitively.  Additionally you do not have to enter the complete
  1306. name. KCommodity supports all AmigaDOS wildcards.
  1307.  
  1308.    Here is an example for defining the task of CygnusED
  1309.  
  1310.                                  #?ED
  1311.  
  1312.    This entry will patch all tasks with a string of *ED* at the end of
  1313. their names. As you can see, the only important characters are *ED*. You
  1314. should always use this definition, since CygnusED does something weird
  1315. while opening it`s screen, when launched a second time (but who does
  1316. this that often ?).
  1317.  
  1318.    Additionally you can tell KCommodity to leave out a task from being
  1319. patched.  This is done by simply inserting a '-' in front of the task`s
  1320. name.
  1321.  
  1322.                                  -#?ED
  1323.  
  1324.    This will stop all tasks having a 'ED' within their names from being
  1325. patched.
  1326.  
  1327.    *NOTE:* You can not change the name of the GLOBAL TAG. If you try to
  1328. enter **** GLOBAL TAG ****, KCommdity will restore the previously
  1329. entered name.
  1330.  
  1331. Add entry
  1332. ---------
  1333.  
  1334.    This gadget will add a new entry to the list of tasks. The name of
  1335. the new task will be set to *--- Unused entry ---*. You can now enter
  1336. the real name of the task to be watched.
  1337.  
  1338. Add Global
  1339. ----------
  1340.  
  1341.    This gadget will tell KCommodity to insert the special *GLOBAL TAG*,
  1342. which is the one to be used for tasks not available within the list. The
  1343. entry`s name may not be changed, it is only a synonym for a global
  1344. setting.
  1345.  
  1346. Select entry
  1347. ------------
  1348.  
  1349.    If you are not sure of how the name of a task is spelled, simply
  1350. click on this gadget. A window will pop up, with a list of all
  1351. available tasks currently in the system. Prerequisite for this function
  1352. to work on the task you desire, is that you first start the task,
  1353. before selecting this function. If you`ve found the task within the
  1354. list, simply click on it`s name. The name will then be copied to the
  1355. selected entry. To learn more about that selection window, have a look
  1356. at TaskWin.
  1357.  
  1358. Remove entry
  1359. ------------
  1360.  
  1361.    This gadget will simply remove the selected entry from the list.
  1362.  
  1363.    *WARNING:* KCommodity will not ask you for confirmation
  1364.  
  1365. Hard Patch
  1366. ----------
  1367.  
  1368.    You can tell KCommodity to be safe when patching screens. When this
  1369. gadget is turned off, KCommodity will only patch those screens, no
  1370. TagList or extended screen structure is attached to, when opening. So
  1371. this has only effects on screens opened under OS 1.3 mode.
  1372.  
  1373.    When the gadget is turned on, KCommodity will patch all screens and
  1374. set the chosen modes and flags for the screen, no matter whether the
  1375. screen is opened with a TagList or not. This might be very dangerous,
  1376. if the application opening the screen relys on the modes and flags set
  1377. up by the application. So watch out, and try some settings, before
  1378. blaming me. I told you.
  1379.  
  1380. AutoScroll
  1381. ----------
  1382.  
  1383.    Setting this gadget will tell KCommodity to activate the AutoScroll
  1384. flag for the screen to be opened.
  1385.  
  1386.    You might know this feature from the WorkBench screen. When you drag
  1387. the screen a little bit down and then hit the bottom border of the
  1388. screen with your mouse, the screen will automatically move upward. The
  1389. same happens, if you touch the left/right screen borders, and the
  1390. screen is wider than the maximum display width.
  1391.  
  1392. Font
  1393. ----
  1394.  
  1395.    This gadget tells KCommodity to set the screens font to *topaz8*. If
  1396. you set *Hard Patch* for the task, the screen will have topaz8, no
  1397. matter what the application requested (see HardPatch).
  1398.  
  1399. Monitor
  1400. -------
  1401.  
  1402.    This gadget is connected with the *ScreenMode, Screen Height, and
  1403. Screen Width* gadgets (see ScreenMode, ScrHeight, and ScrWidth).
  1404.  
  1405.    If Monitor is set, these three gadgets are available to be set by
  1406. you. If not, you can not make any changes to these settings, and
  1407. KCommodity will not patch the DisplayID, Height, and Width entries of
  1408. the screen to be opened.
  1409.  
  1410. SA-Pens
  1411. -------
  1412.  
  1413.    This is the magic flag for obtaining the OS 2.0 look. If set,
  1414. KCommodity will insert the appropriate DrawPens when opening the
  1415. screen. KCommodity will check for OS 2.0 and OS 3.0, when setting the
  1416. DrawPens, so that the screen always looks good on any system.
  1417.  
  1418. System Pens
  1419. -----------
  1420.  
  1421.    Per default KCommodity will determine which set of DrawPens to use
  1422. (see SAPens). These pens will be set according to the version of OS you
  1423. are running. Under OS 3.0 three new pens were introduced, but adding
  1424. these to a screen, which believes the colors of the titlebar to be some
  1425. specific kind, could result in ugly screen rendering (Like CygnusED).
  1426. If you unset this gadget, KCommodity will always supply the OS 2.0
  1427. DrawPens, in order to keep the titlebar untouched.
  1428.  
  1429. BlackBorder
  1430. -----------
  1431.  
  1432.    This flag tells KCommodity to blank the Genlock border to the left
  1433. and right of the screen, which will normally be black.
  1434.  
  1435.    *NOTE:* This gadget/setting is only available, if you have an
  1436. ECS-Denise equipped computer.
  1437.  
  1438. AutoCenter
  1439. ----------
  1440.  
  1441.    Using this gadget you may horizontally center screens, which do not
  1442. open with full width.
  1443.  
  1444. Interleave
  1445. ----------
  1446.  
  1447.    This gadget is only available under OS 3.0 or later.
  1448.  
  1449.    It will tell KCommodity to set the Interleaved-BitMap-Flag when
  1450. opening the screen. Interleaved BitMaps will result in a somewhat
  1451. faster display refreshing/drawing. Somehow there might be problems with
  1452. older programs or with programs working with the old BitPlane format
  1453. (like View80).
  1454.  
  1455. Like WorkBench
  1456. --------------
  1457.  
  1458.    This gadget is only available under OS 3.0 or later.
  1459.  
  1460.    If you want to have a new screen to be opened with the dimensions
  1461. and depth just like WorkBench, simply activate this gadget.
  1462.  
  1463. ScreenMode
  1464. ----------
  1465.  
  1466.    This gadget is only available, if you activated Monitor. You can use
  1467. this gadget to select a new screen mode for the task`s screens. A
  1468. requester will pop up listing all available screenmodes. This will
  1469. either be an ASL-ScreenModeRequester or a ReqTools ScreenModeRequester
  1470. (Version 38.1022 of the reqtools.library is included), depending on the
  1471. OS you are running.
  1472.  
  1473. Screen Height
  1474. -------------
  1475.  
  1476.    This gadget is used to set a specific screen height for the screen
  1477. to be opened. Simply enter the height you prefer for the screen.
  1478.  
  1479.    If you supply 0 for the height, KCommodity will simply use the
  1480. screen`s default height.
  1481.  
  1482. Screen Width
  1483. ------------
  1484.  
  1485.    Similar to *Screen Height* you can set a specific screen width (see
  1486. ScrHeight, for more information), for the screen to be opened.
  1487.  
  1488. Mouse
  1489. =====
  1490.  
  1491.    Within this window you can control mouse specific features offered by
  1492. KCommodity. Here you find gadgets for defining the type of window
  1493. activation you prefer, gadgets for setting the mouse acceleration and
  1494. some other functions, you will get to know, when reading this section.
  1495.  
  1496.    For additional informations and topics concerning window activation
  1497. refer to LockWins.
  1498.  
  1499. Window activation
  1500. -----------------
  1501.  
  1502.    This gadget enables/disables window activation. The type of
  1503. activation is determined by SunMouse. If you turn off this gadget, no
  1504. window activation will occure.
  1505.  
  1506. Sun mouse
  1507. ---------
  1508.  
  1509.    This gadget determines the type of window activation. If set, all
  1510. windows will be activated, that are touched by the mouse. That doesn`t
  1511. really mean, every window will be activated. If you move the mouse at a
  1512. high speed, only that window will be activated, the mouse comes to a
  1513. stop over. If you move the mouse at a slow speed (of about 5-10 pixels
  1514. in either direction), all windows will be activated, when they are
  1515. touched by the mouse.
  1516.  
  1517.    If you turn off this gadget, KCommodity will only activate windows,
  1518. the mouse is over *and* when a key is hit.
  1519.  
  1520. Mouse accelerate
  1521. ----------------
  1522.  
  1523.    This gadget will turn on/off mouse acceleration. The acceleration is
  1524. controled by the gadgets Accel and Thresh.
  1525.  
  1526. Window reactivation
  1527. -------------------
  1528.  
  1529.    Per default, KCommodity always remembers the currently active window
  1530. on each screen you have been on. When returning to a screen, KCommodity
  1531. will look for the "active" window on that screen and will reactivate
  1532. it. You can disable this behaviour by using this gadget.
  1533.  
  1534. Acceleration
  1535. ------------
  1536.  
  1537.    This gadget sets the acceleration for the mouse. Values between 2
  1538. and 10 are accepted, that means you define the acceleration factor for
  1539. the mouse.
  1540.  
  1541. Threshold
  1542. ---------
  1543.  
  1544.    This slider gadget is used in conjunction with Accel. It sets the
  1545. threshold for mouse acceleration. The higher the value, the faster you
  1546. have to move to the mouse, before KCommodity will start to accelerate.
  1547.  
  1548. LeftyMouse
  1549. ----------
  1550.  
  1551.    This is for users, who prefer to have the mouse buttons swapped
  1552. (left and right button). All functions the buttons normally perform,
  1553. are swapped from left to right now.
  1554.  
  1555. Hold mouse
  1556. ----------
  1557.  
  1558.    In conjunction with the correct qualifier, you can lock
  1559. mousemovement in one or both directions (X-direction or Y-direction).
  1560. This gadget turns on/off mouse movement locking.
  1561.  
  1562. Hold X qualifier
  1563. ----------------
  1564.  
  1565.    This gadget will open the QualWin.  You can then select a new
  1566. qualifier to be used in order to lock mouse x-movements.
  1567.  
  1568. Hold Y qualifier
  1569. ----------------
  1570.  
  1571.    This gadget has a similar meaning as the one just described (see
  1572. HoldX). You can re-define the qualifier for locking mouse y-movements.
  1573.  
  1574. HotKey window
  1575. =============
  1576.  
  1577.    This window allows you to change all hotkeys supported by
  1578. KCommodity. The HotKeys are only available, when the main program is
  1579. running. Otherwise you can only change the HotKey definitions. You can
  1580. reach several functions only when there are available HotKeys.
  1581.  
  1582.    Have a look at HotKeyDef, to get to know the descriptive strings for
  1583. HotKeys.
  1584.  
  1585.    If you enter "None" for the descriptive text the corresponding
  1586. HotKey will be disabled.
  1587.  
  1588.    For a complete list of available HotKeys refer to KCXHotKeys.
  1589.  
  1590.    This window only offers two gadgets:
  1591.  
  1592. HotKeys
  1593. -------
  1594.  
  1595.    This listview gadget shows all available HotKeys by their names. If
  1596. you click on a HotKey`s name, it`s definition will be copied to the
  1597. string gadget. (see Def).
  1598.  
  1599. Def
  1600. ---
  1601.  
  1602.    This string gadget is used to define a new HotKey for a selected
  1603. entry.  If you are not used to HotKey definitions the commodities
  1604. system uses, refer to HotKeyDef.
  1605.  
  1606.    If you enter a string, which contains an incorrect definition,
  1607. KCommodity will restore the previously used definition.
  1608.  
  1609. Defining a HotKey
  1610. -----------------
  1611.  
  1612.    To ease the definition of a HotKey here is a list of
  1613. key-descriptions the system "knows".
  1614.  
  1615.    Here is a list of qualifiers.
  1616.  
  1617. `ALT'
  1618.      Any Alt key.
  1619.  
  1620. `RALT'
  1621.      Only the right Alt key.
  1622.  
  1623. `LALT'
  1624.      Only the left Alt key.
  1625.  
  1626. `SHIFT'
  1627.      Either Shift key.
  1628.  
  1629. `RSHIFT'
  1630.      The right Shift key.
  1631.  
  1632. `LSHIFT'
  1633.      Only the left Shift Key.
  1634.  
  1635. `CAPSLOCK'
  1636.      Capslock must be pressed.
  1637.  
  1638. `LCOMMAND'
  1639.      Left Amiga key.
  1640.  
  1641. `RCOMMAND'
  1642.      Right Amiga key.
  1643.  
  1644. `CONTROL'
  1645.      Control Key.
  1646.  
  1647. `NUMERICPAD'
  1648.      Keys of the Numeric Keypad are accepted.
  1649.  
  1650. `RBUTTON'
  1651.      Right mousebutton.
  1652.  
  1653. `MIDBUTTON'
  1654.      Middle mousebutton.
  1655.  
  1656. `LEFTBUTTON'
  1657.      Left mousebutton.
  1658.  
  1659. `NEWPREFS'
  1660.      Preferences have been changed. Maybe a new font was selected.
  1661.  
  1662. `DISKREMOVED'
  1663.      A disk was removed from a drive.
  1664.  
  1665. `DISKINSERTED'
  1666.      A disk was inserted into a drive.
  1667.  
  1668.    These are the qualifiers you can use in almost every combination.
  1669. Now we come to the descriptions of "normal" keys.
  1670.  
  1671. `A - Z, 0 - 9, etc.pp.'
  1672.      Normal keys, as you see them on the keyboard.
  1673.  
  1674. `F1 - F10'
  1675.      The ten function keys.
  1676.  
  1677. `UP, DOWN, LEFT, RIGHT'
  1678.      The cursor keys up, down, left, and right.
  1679.  
  1680. `HELP'
  1681.      The Help key.
  1682.  
  1683. `DEL'
  1684.      Delete key (beside HELP).
  1685.  
  1686. `BACKSPACE'
  1687.      Backspace key
  1688.  
  1689. `RETURN'
  1690.      Return key.
  1691.  
  1692. `ENTER'
  1693.      Enter on Numeric Keyboard (only, if NUMERICPAD was specified).
  1694.  
  1695. `ESC'
  1696.      Escape key.
  1697.  
  1698. `SPACE'
  1699.      Space.
  1700.  
  1701. `COMMA'
  1702.      A comma.
  1703.  
  1704. `UPSTROKE'
  1705.      The apostroph (to the left of the 1).
  1706.  
  1707.    You can use as many qualifiers as you wish, but only one key per
  1708. description.  This is the syntax for a HotKey definition:
  1709.  
  1710.                     [QUALIFIER [QUALIFIER ...]] KEY
  1711.  
  1712.    As you can see the qualifiers can be totally left out, but in how
  1713. far this is usefull depends on you. Entering "None" (without quotes)
  1714. will disable a HotKey.
  1715.  
  1716. KCommodity`s HotKeys
  1717. --------------------
  1718.  
  1719.    There are several different HotKeys managed by KCommodity. Each of
  1720. these may be changed alternatively. To find out, what the HotKeys are
  1721. used for, simply get to the HotKey in question and check it out.
  1722.  
  1723. CX_PopKey
  1724. ---------
  1725.  
  1726.    You might already know this HotKey. This is the one to let the
  1727. Preferences Editor pop up. Per default this will be LCOMMAND HELP. Note
  1728. that the settings will override the ToolType definition (see ToolTypes).
  1729.  
  1730. Bill
  1731. ----
  1732.  
  1733.    This HotKey is used to tell KCommodity to open the Bill window (see
  1734. BillWin). Per default this will be ALT SHIFT B.
  1735.  
  1736. Formatter
  1737. ---------
  1738.  
  1739.    This HotKey will let you open the Formatter window (see FormatWin),
  1740. so you may format drives "manually".  The default definition for this
  1741. HotKey is ALT SHIFT F.
  1742.  
  1743. Page
  1744. ----
  1745.  
  1746.    As mentioned before you can use different pages for the clock/memory
  1747. display (see ClockDef). This is the HotKey to cycle through the
  1748. different pages available.  Have a look at the corresponding section,
  1749. to see, which pages are available. The definition is RALT HELP.
  1750.  
  1751. UserShell
  1752. ---------
  1753.  
  1754.    As mentioned before, KCommodity can open a shell when a HotKey is
  1755. pressed.  Per default, this HotKey is ALT SHIFT S. You can change it
  1756. here.
  1757.  
  1758. Map "Umlauts"
  1759. -------------
  1760.  
  1761.    As mentioned under MapUmlauts, KCommodity may map the german
  1762. "Umlauts" for you. You do not have to go to the Settings window every
  1763. time you want to turn that function on/off. Simply hit the HotKey to
  1764. toggle that function. Per default this HotKey will be ALT SHIFT U.
  1765.  
  1766. Snap memory
  1767. -----------
  1768.  
  1769.    You can define the HotKey for the "Snap memory" function here. The
  1770. first time you hit the HotKey the screen will flash. This signalizes
  1771. that KCommodity made a snapshot of the currently available memory. If
  1772. you hit the HotKey a second time the time/memory display will change to
  1773. a different page showing how much memory was freed / got lost. A
  1774. possible display could be:
  1775.  
  1776.                    Snapped  C:      0   F:        0
  1777.  
  1778.    This display tells you that neither chip memory nor fast memory was
  1779. occupied / freed during the time between the two calls of the "Snap
  1780. memory" function. If memory got lost the values shown will be negative,
  1781. otherwise they will be positive.
  1782.  
  1783.    This display will only show up if the "Snap memory" function is
  1784. used. The Page HotKey can *not* be used to switch to that page.
  1785.  
  1786.    To get back to the normal display just hit the Page HotKey. The
  1787. default setting for this HotKey is ALT SHIFT G.
  1788.  
  1789. Immediate blank
  1790. ---------------
  1791.  
  1792.    If you do not want to wait for the screen timeout to elaps you may
  1793. tell KCommodity to blank the screen immediately. This is done by
  1794. hitting this HotKey which is ALT SHIFT D per default.
  1795.  
  1796. Display dump
  1797. ------------
  1798.  
  1799.    Hitting this HotKey will tell the main program to start the external
  1800. printer driver. The default HotKey definition is ALT NUMERICPAD *,
  1801. which stands for the key labeled 'PrtSc' to the upper right.
  1802.  
  1803. Center
  1804. ------
  1805.  
  1806.    If you moved a screen to the left/right and want to recenter it,
  1807. then you should simply hit this HotKey, in order to perform that
  1808. action. The default definition for this HotKey is ALT SHIFT X.
  1809.  
  1810. Select screen
  1811. -------------
  1812.  
  1813.    This HotKey will open the Select screen window. You can then choose
  1814. a screen to be brought to front. Have a look at SelScrWin, for more
  1815. information about that.  The default setting for this HotKey is LSHIFT
  1816. ESC.
  1817.  
  1818. Clock/Memory on/off
  1819. -------------------
  1820.  
  1821.    You do not have to turn off the clock/memory display via the Clock
  1822. definitions window. Simply hit this HotKey to perform that action. The
  1823. default definition is ALT SHIFT C.
  1824.  
  1825. Function keys on/off
  1826. --------------------
  1827.  
  1828.    If your function keys collide with the ones defined by an
  1829. application you may turn off KCommodity`s function keys by hitting this
  1830. HotKey. The default definition for this HotKey is ALT SHIFT K.
  1831.  
  1832. SunMouse keys on/off
  1833. --------------------
  1834.  
  1835.    Using this HotKey you may switch between SunMouse windowactivation
  1836. and the method of hitting a key in order to activate a window. Default
  1837. definition is ALT SHIFT M.
  1838.  
  1839. Graphics dump
  1840. =============
  1841.  
  1842.    This gadget will inform KCommodity (the main program) to launch the
  1843. external graphics dump module. If you didn`t start KCommodity, this
  1844. gadget will be ghosted and so this function is unavailable. Have a look
  1845. at DisplayDump, for more information about the graphics dump module.
  1846.  
  1847. Function Keys
  1848. =============
  1849.  
  1850.    KCommodity offers the possibility to map strings onto the function
  1851. keys. You are not restricted to only one mapping per key, you can have
  1852. up to four different strings for each function key. To reach these
  1853. strings you simply have to hit a qualifier.
  1854.  
  1855.    Additionally there are three special *strings*, you can use. These
  1856. can perform special functions KCommodity offers.
  1857.  
  1858.    As said under FuncKey, KCommodity`s function key mappings may be
  1859. turned on/off by hitting a HotKey.
  1860.  
  1861. F1 - F10
  1862. --------
  1863.  
  1864.    These string gadgets are used to enter the strings for each function
  1865. key to be mapped when hit in conjunction with the chosen qualifier. But
  1866. not only normal characters are supported. For special control sequences
  1867. have a look at the following list:
  1868.  
  1869.    * ANSI - Any ANSI sequences may be entered.
  1870.  
  1871.    * Special codes starting with \
  1872.        1. \n - Return
  1873.  
  1874.        2. \r - Return
  1875.  
  1876.        3. \t - TAB
  1877.  
  1878.        4. \\ - \-Code
  1879.  
  1880.    * Keydefinition between <> An example: abc<alt f1>\nHello. This
  1881.      would insert the definition of ALT + F1 between abc and \n. As you
  1882.      can see these definitions are the same as presented in HotKeyDef.
  1883.  
  1884.    And here are the special strings mentioned above:
  1885.  
  1886.    * MINWIN The window underneith the mouse pointer will be changed to
  1887.      minimum size and moved to the upper left corner of the screen.
  1888.  
  1889.    * MAXWIN The window underneith the mouse pointer will be brought to
  1890.      maximum size and moved to the upper left corner of the screen.
  1891.  
  1892.    * ZIPWIN Windows equiped with a Zoom Gadget can be handeled using
  1893.      this command. The window underneith the mouse pointer will zip to
  1894.      it`s alternative size/position.
  1895.  
  1896. Qualifier
  1897. ---------
  1898.  
  1899.    This gadget determines the qualifier to be used in order to insert a
  1900. given function key`s string. Available qualifiers are :
  1901.  
  1902.    * NONE No key.
  1903.  
  1904.    * SHIFT Either SHIFT key.
  1905.  
  1906.    * ALT Either ALT key.
  1907.  
  1908.    * CONTROL CONTROL key.
  1909.  
  1910. Active
  1911. ------
  1912.  
  1913.    This gadget sets the state of KCommodity`s function key mapping
  1914. facility. If active, the function keys will be mapped according to your
  1915. settings. This gadget may also be used via HotKey (see FuncKey, for
  1916. more).
  1917.  
  1918. Ok
  1919. --
  1920.  
  1921.    Selecting this gadget will inform KCommodity to copy your function
  1922. key settings to it`s internal buffer.
  1923.  
  1924.    *NOTE:* The new function keys are only available when you clicked
  1925. onto this gadget, no matter whether *Active* is selected or not.  See
  1926. FKeyAct, for more information.
  1927.  
  1928. Cancel
  1929. ------
  1930.  
  1931.    Clicking onto this gadget will tell KCommodity, that you wish to
  1932. cancel the setting of function key strings. All changes made to the
  1933. function keys will be lost, and the previously used keys will be
  1934. re-installed.
  1935.  
  1936. Lock windows
  1937. ============
  1938.  
  1939.    Here you find some additional possibilities for manipulating the
  1940. *Window activation* facilities of KCommodity (see Mouse, for more
  1941. information about window activation).
  1942.  
  1943.    KCommodity will allow you to specify certain windows which are *not*
  1944. to be deactivated by the program`s window activator, that means, no
  1945. matter which type of activation selected, the window will stay active,
  1946. once activated. You can move the mouse out of the window, hit a key, or
  1947. do anything else, the window will stay active. The only way to activate
  1948. another window is to use the conventional method (clicking on the
  1949. window in question). This feature can only be used with windows having
  1950. a title.
  1951.  
  1952.    Additionally you may define Tasks, who`s windows are to be protected
  1953. from deactivation. Simply supply the name of the task you which and
  1954. KCommodity will lock all of it`s windows.
  1955.  
  1956.    All entries are treated case-insensitive. AmigaDOS wildcards are
  1957. allowed and supported.
  1958.  
  1959. Locked list
  1960. -----------
  1961.  
  1962.    This listview gadget will show you all names of windows/tasks to be
  1963. locked.  Depending on the type of list being displayed you will see
  1964. names of windows or names of tasks (see LockType, for more). Simply
  1965. click on an entry to change the name. The name will be copied to the
  1966. string gadget underneith the listview gadget.
  1967.  
  1968. Entry
  1969. -----
  1970.  
  1971.    This string gadget will show the name of the selected entry. You can
  1972. edit the name here, so that it suits your needs. Do not worry about how
  1973. to write the name, they are all treated case-insensitive (you will have
  1974. to spell it correctly, though). AmigaDOS wildcards are supported here.
  1975.  
  1976. List
  1977. ----
  1978.  
  1979.    As mentioned before, KCommodity offers two methods for locking
  1980. windows. The first is to lock a window simply by supplying it`s name.
  1981. The second is to supply a task`s name, who`s windows are to be locked.
  1982. To tell KCommodity how to treat the entries, you have to select the
  1983. appropriate list, using this gadget. If it shows *Windows*, all entries
  1984. are treated to be names of windows. If it shows *Tasks*, the entries
  1985. are treated to be names of tasks.
  1986.  
  1987. Add entry
  1988. ---------
  1989.  
  1990.    Clicking onto this gadget will tell KCommodity to add an entry to
  1991. the end of the list. This entry will have the name of *--- Unused entry
  1992. ---*. The string gadget will become the active gadget, allowing you to
  1993. enter the name of the window/task to be locked.
  1994.  
  1995. Select entry
  1996. ------------
  1997.  
  1998.    This gadget will give you the possibility to select an existing
  1999. window/task to be locked. Depending on the type of list being edited,
  2000. there are two ways to specify the name of an existing entry.
  2001.  
  2002.    For windows you will have to click onto the window in question.
  2003. Having selected this gadget, the window`s titlebar will change telling
  2004. you what to do : *Click on window to use*. You are questioned to click
  2005. onto the window you want to add to the list of windows. If you try to
  2006. select a window which does not have a titlebar text, KCommodity will
  2007. inform you, that it can not handle something like that.
  2008.  
  2009.    For tasks a window will pop up, showing a list of all tasks
  2010. available. Simply click onto the task you want to add to the list of
  2011. tasks. See TaskWin, for more information about this window.
  2012.  
  2013. Delete entry
  2014. ------------
  2015.  
  2016.    This gadget will have the effect of deleting the selected entry.
  2017.  
  2018.    *WARNING:* KCommodity will *not* ask for confirmation.
  2019.  
  2020. Formatter
  2021. =========
  2022.  
  2023.    This gadget is only available, if the main KCommodity is running.
  2024. Otherwise it is ghosted. Using this gadget you tell KCommodity to open
  2025. it`s formatter window.
  2026.  
  2027. Bill preferences
  2028. ================
  2029.  
  2030.    This window is used to set the various elements for telephone cost
  2031. calculation. Here you find several gadgets to specify the length of a
  2032. unit for all three timezones supported (either cheap or normal tariff).
  2033. Additionally you can tell KCommodity which weekdays are to be treated as
  2034. *always cheap*, that means, KCommodity will always use cheap tariffs
  2035. then.
  2036.  
  2037.    To have more information about telephone cost calculation refer to
  2038. TelCost.
  2039.  
  2040. Normal 1 - Normal 3
  2041. -------------------
  2042.  
  2043.    These gadgets are used to enter the times for one unit concerning
  2044. the normal tariff. The numbering from 1 to 3 is for the three available
  2045. time zones. Within these gadgets only numerical inputs are allowed.
  2046. Negative inputs will lead to a restore of the previously used value.
  2047. The program believes these values to be seconds, that means you will
  2048. have to calculate the correct values to enter minutes.
  2049.  
  2050. Cheap A - Cheap C
  2051. -----------------
  2052.  
  2053.    These gadgets almost have the same meaning as the ones mentioned
  2054. above (see NormalT). The only difference is that the times entered are
  2055. for the cheap tariffs of the three time zones.
  2056.  
  2057.                         An example for an input
  2058.  
  2059.        Normal time / unit 1: 360   Means 6 minutes for one unit.
  2060.  
  2061.        Cheap time / unit 1: 720   Means 12 minutes for one unit.
  2062.  
  2063.    The default times correspond to these valid in Germany.
  2064.  
  2065. Cost/Unit
  2066. ---------
  2067.  
  2068.    This gadget only accepts numerical inputs, too. Enter the costs for
  2069. one unit. These inputs are made in cents, that means that an input of
  2070. 23 is interpreted as 23 Pfennige (cents). Negative values will lead to
  2071. a restore of the previously used value, too.
  2072.  
  2073. Sunday - Saturday
  2074. -----------------
  2075.  
  2076.    These gadgets mark weekdays for use of cheap tariff the whole day. A
  2077. selected gadget tells KCommodity that normal tariff is not to be used on
  2078. that day.
  2079.  
  2080. Start normal/Start cheap
  2081. ------------------------
  2082.  
  2083.    These gadgets are used to determine the start times for normal and
  2084. cheap tariffs. KCommodity will check the system time and alter the
  2085. tariff accordingly. *Start normal* is used to set the start time for
  2086. normal tariff and *Start cheap* is used for cheap tariff. If the border
  2087. between normal/cheap is passed during connection time, no changes to the
  2088. costs are made, but all forthcoming units will be calculated correctly.
  2089.  
  2090. Pop up Bill window
  2091. ------------------
  2092.  
  2093.    Using this CheckBox gadget you can determine whether KCommodity
  2094. should open the Bill window automatically whenever it recognizes a
  2095. Carrier Detect. If the Carrier is gone (hanging up the modem)
  2096. KCommodity will close the window again. If the window was already
  2097. present on a Carrier Detect the program will not close the window when
  2098. you hang up.
  2099.  
  2100. Activate on PopUp
  2101. -----------------
  2102.  
  2103.    Per default the Bill window will *not* be activated, when opened. You
  2104. can tell KCommodity to activate the window on open-up, using this
  2105. gadget.
  2106.  
  2107. Clear Log
  2108. ---------
  2109.  
  2110.    Selecting this gadget will tell the program to clear the log file
  2111. with all the information about the past calls.
  2112.  
  2113. Display total sum
  2114. -----------------
  2115.  
  2116.    Attention, this gadget could become dangerous :-) When you click
  2117. onto this gadget a Requester will be opened asking where to put the
  2118. listing to. You can choose from a file or a window. If you selected
  2119. "Window", a window will be opened showing information about the calls
  2120. you`ve made with your modem. After all entries for one day have been
  2121. listed KCommodity will print out the sum for that day. At the end of
  2122. the list the program will give you the total sum for all calls made.
  2123. This is also done when redirecting the listing to a file.
  2124.  
  2125. Open Bill on
  2126. ------------
  2127.  
  2128.    You can enter a list of Public Screen names here, on which
  2129. KCommodity should open the *Bill* window. The names are seperated by
  2130. semikolons ";".  Please remember that KCommodity tries to open the
  2131. window on the first screen available, that means that if the first
  2132. screen of the list is present the window would *never* be opened on the
  2133. second screen. An example:
  2134.  
  2135.                            TERM;PowerPacker
  2136.  
  2137.    KCommodity would try to open the window on Term`s (1) screen. If
  2138. this screen is not available the program will then try to find
  2139. PowerPacker`s (2) screen to open the window on.
  2140.  
  2141.    Remember that the search for the names is case-sensitive, that means
  2142. KCommodity can *never* find a screen called "Term".
  2143.  
  2144.    ---------- Footnotes ----------
  2145.  
  2146.    (1)  A very powerful terminal program by Olaf 'Olsen' Barthel
  2147.  
  2148.    (2)  A very efficient packer by Nico Francois
  2149.  
  2150. Log Filename
  2151. ------------
  2152.  
  2153.    If you are already sure about the log file`s name and location you
  2154. can easily enter the path / filename here. KCommodity will make sure
  2155. that it is possible to write the file otherwise the previously used
  2156. file will be reselected.
  2157.  
  2158.    If you do not really know where to place the logfile, use LogSelect
  2159. to do it the easy way.
  2160.  
  2161. Select
  2162. ------
  2163.  
  2164.    When you select this gadget a file requester will open up giving you
  2165. the possibility to select a new log file.
  2166.  
  2167. Alarm modes
  2168. ===========
  2169.  
  2170.    KCommodity may wake you up after a given time, and/or to every full
  2171. hour. It will then display a requester (if desired) and play a sound.
  2172. This sound can either be a normal DisplayBeep() sound or an IFF-8SVX
  2173. sample.
  2174.  
  2175. Alarm on
  2176. --------
  2177.  
  2178.    This gadget simply turns on/off the alarm function of KCommodity. If
  2179. turned off KCommodity will not play any alarm.
  2180.  
  2181. Every hour
  2182. ----------
  2183.  
  2184.    If you want to have an alarm every full hour (in addition to the
  2185. specified alarm time), you may tell KCommodity to do so, via this
  2186. gadget. Turn this gadget on, to be alarmed every hour.
  2187.  
  2188. Show requester
  2189. --------------
  2190.  
  2191.    KCommodity may either show a requester when it alarms you, or it
  2192. will simply play the selected sound. Turning on this gadget will tell
  2193. KCommodity to pop up a requester to alarm you (in addition to the
  2194. sound).
  2195.  
  2196. Alarm time
  2197. ----------
  2198.  
  2199.    Using this gadget you select the alarm time. The input does not
  2200. accept seconds however, but I think hour and minutes should suffice.
  2201.  
  2202. Sound type
  2203. ----------
  2204.  
  2205.    Here you can select the type of sound to be played on "wake-up". When
  2206. using *DisplayBeep()* the display will flash and a soft beep will be
  2207. heard. If you do not like that type of behaviour, simply select *IFF
  2208. Sample*. Now you can select an IFF-8SVX file to be played every alarm.
  2209.  
  2210. Select sample
  2211. -------------
  2212.  
  2213.    This gadget is only available, if you selected *IFF Sample* under
  2214. *Sound type* (see SoundType). If you click on this gadget a
  2215. FileRequester will pop up giving the possibility to select a new
  2216. sample. Underneith this gadget the name of the selected sample will be
  2217. displayed.
  2218.  
  2219. Test sample
  2220. -----------
  2221.  
  2222.    Clicking onto this gadget will play the selected IFF-8SVX sample.
  2223.  
  2224. Bill
  2225. ====
  2226.  
  2227.    This gadget will tell KCommodity (the main part) to open it`s bill
  2228. window.  See BillWin, for more information about this window. This
  2229. gadget is only available (not ghosted), when KCommodity is running.
  2230.  
  2231. Qualifier window
  2232. ================
  2233.  
  2234.    This window is used by various functions to define a key-combination
  2235. for performing special function (eg. Full drag).
  2236.  
  2237.    When opened all special functions of KCommodity will be deactivated
  2238. to guarantee a non-interrupted definition. Simply hit the
  2239. key-combination you want to use. KCommodity will then display all keys
  2240. hit within a small box. If you wonder why you can not change the code
  2241. (main key within single quotes) it is because of the function the
  2242. key-combination is for. For example you can not change the code for ESC
  2243. Window Close (see ESCWindowClose).
  2244.  
  2245.    *NOTE:* When defining a combination including the left mousebutton,
  2246. you must not click within the text box, nor on one of the gadgets
  2247. because these are all gadgets and Intuition will consume the clicks,
  2248. before getting to KCommodity.
  2249.  
  2250. Task window
  2251. ===========
  2252.  
  2253.    Within this small window you will find a list of all tasks currently
  2254. loaded into system. The names of the tasks are not sorted, so you may
  2255. have to search a while before finding the needed task. This window will
  2256. be opened by some functions, in order to let you decide which task to
  2257. use for the specified function. You can cancel the selection by closing
  2258. the window (clicking onto the close gadget).
  2259.  
  2260. The Printer Driver
  2261. ******************
  2262.  
  2263.    This external module is used to dump graphics to either a printer
  2264. (which should support graphics of course) or an IFF-ILBM graphics file.
  2265. You can simply define the source which should be dumped and select an
  2266. area or the complete image. KCommodity can have whole screens or only
  2267. windows as sources.
  2268.  
  2269.    When launched the printer module will open a screen, which will have
  2270. the same dimensions and resolutions as the Workbench screen.  On that
  2271. screen, there will be the graphics dump window.
  2272.  
  2273.    You have complete access to the printer preferences. These will not
  2274. be copied to/from the original preferences set up by the Printer and
  2275. PrinterGfx editors, so that you may choose your own defaults.
  2276.  
  2277.    On startup the printer module will search for the active screen and
  2278. the active window. These will be given as sources you can dump from and
  2279. they may changed later.
  2280.  
  2281. Aspect
  2282. ======
  2283.  
  2284.    You can select the dump`s aspect. The area will either be printed "
  2285. Horizontal", that means horizontally, or "Vertical", say vertically,
  2286. rotated by 90 degrees.
  2287.  
  2288. Shade
  2289. =====
  2290.  
  2291.    You can select the dump-quality, better the creation of shadows.
  2292. Following possibilities are offered.
  2293.  
  2294.    * Black & White The dump will simply be black/white.
  2295.  
  2296.    * Grey Scale 1 Grey scales will be generated for the dump.
  2297.  
  2298.    * Grey Scale 2 Like "Grey Scale 1", but this one is preferable for
  2299.      high-resolution displays and should only be used with four color
  2300.      screens.
  2301.  
  2302.    * Color If your printer supports color dumps, you can tell
  2303.      KCommodity to dump with colors.
  2304.  
  2305. Dithering
  2306. =========
  2307.  
  2308.    This gadget controls the dithering facilities, so you can control
  2309. the dump quality. These are the possibilities:
  2310.  
  2311.    * Ordered The dump dithering will be ordered.
  2312.  
  2313.    * Halftone Dithering will be generated using the halftone method.
  2314.  
  2315.    * Floyd-Steinberg One of the best picture manipulation algorythms
  2316.      around. This option requires a bit more time to produce the dump,
  2317.      but it will give best results.
  2318.  
  2319. Scaling
  2320. =======
  2321.  
  2322.    You have several different options for scaling the output, so that
  2323. you do not waist precious space on the paper. You can choose from the
  2324. following scalings:
  2325.  
  2326.    * Full Page The whole paper will be filled.
  2327.  
  2328.    * inch x inch The values of Size will be treated as inches (see
  2329.      GfxSize, for more about that).
  2330.  
  2331.    * mm x mm KCommodity assumes the "Size" values to be milimeters.
  2332.  
  2333.    * cm x cm Now "Size" values are treated as centimeters.
  2334.  
  2335.    * Fraction Using this setting, you can control how much percent of
  2336.      the paper should be filled. The "Size" values are treated as these
  2337.      percentages.
  2338.  
  2339. Density
  2340. =======
  2341.  
  2342.    This gadget controls the dump`s density. The higher the density, the
  2343. blacker the dark areas of the dump.
  2344.  
  2345. Threshold
  2346. =========
  2347.  
  2348.    You can define the threshold for black/white areas. The higher the
  2349. threshold, the darker the dump.
  2350.  
  2351. Image
  2352. =====
  2353.  
  2354.    Controls the image to be created. It can either be "Positive" or a
  2355. "Negative" image.
  2356.  
  2357. Red, Green, Blue
  2358. ================
  2359.  
  2360.    When "Color" is selected for the "Shade" gadget, these gadgets are
  2361. available to control color correction (see Shade).
  2362.  
  2363. Size
  2364. ====
  2365.  
  2366.    These gadgets control the scaling sizes for the dump. Take a look at
  2367. Scaling, to see how these values are interpreted. These values are
  2368. ignored if you select "Full Page".
  2369.  
  2370. Centered
  2371. ========
  2372.  
  2373.    This gadget tells KCommodity to horizontally center the image.
  2374.  
  2375. Smoothing
  2376. =========
  2377.  
  2378.    This gadget is unavailable, when using "Floyd-Steinberg". Otherwise
  2379. you can tell KCommodity to smothen sharp edges of the output, in order
  2380. to avoid that typical "stair-look" of diagonal lines etc.pp.
  2381.  
  2382. FormFeed
  2383. ========
  2384.  
  2385.    When finished dumping, KCommodity will perform a FormFeed.
  2386.  
  2387. Keep aspect
  2388. ===========
  2389.  
  2390.    If you manually changed the scaling, this gadget tells KCommodity to
  2391. keep the picture`s original aspect/scaling ratio.
  2392.  
  2393. Dump type
  2394. =========
  2395.  
  2396.    This gadget determines the dump`s destination. If you select
  2397. "Printer" KCommodity will dump the graphics to a printer. If you select
  2398. "File" instead, you will be prompted for a file to dump the graphics to.
  2399.  
  2400. Graphic
  2401. =======
  2402.  
  2403.    This gadget controls the area to be dumped from. If "Complete" is
  2404. selected, the whole source will be dumped, but if you select "Area" then
  2405. you can define an area which should be dumped. See DefArea, to see how
  2406. to define an area.
  2407.  
  2408. X, Y, W, H
  2409. ==========
  2410.  
  2411.    These Integer gadgets control the area to be dumped. They are
  2412. unavailable if you select "Complete" for the "Graphic" gadget (see
  2413. Graphic).
  2414.  
  2415. Source
  2416. ======
  2417.  
  2418.    As mentioned earlier KCommodity searches for two sources. Here you
  2419. can define which of the two should be used as source for the dump.
  2420. KCommodity tries to show the source`s name to the right of this gadget.
  2421.  
  2422. Reselect Source
  2423. ===============
  2424.  
  2425.    Clicking on this gadget will change the window`s titlebar, telling
  2426. you to select a new source by clicking on it. So just move the mouse
  2427. over a new window/screen you wish to dump and hit the left mouse button.
  2428. KCommodity will fetch data for the new sources.
  2429.  
  2430. Define Area
  2431. ===========
  2432.  
  2433.    Having selected "Area" you may now define the dump-area by using the
  2434. mouse. The selected source will pop to front and a rectangle will be
  2435. drawed from the upper left corner to the current mouse position. To set
  2436. a new start position for the rectangle just click the left mouse
  2437. button. To quit simply hit the right mousebutton. The new values will
  2438. be copied to KCommodity`s integer gadgets.
  2439.  
  2440. Dump
  2441. ====
  2442.  
  2443.    This gadget will start the dump. KCommodity will first check your
  2444. inputs before starting the dump. If any errors are encountered
  2445. KCommodity will pop up a Requester "Please check your inputs".
  2446. Otherwise your printer will soon start to dump. To cancel the dump,
  2447. simply hit the "Cancel" gadget.  If the selected printer does not
  2448. support graphics dumps KCommodity will inform you.
  2449.  
  2450.    If you are dumping to a file a FileRequester will first pop up and
  2451. you can select a file then. KCommodity will dump the data to that file.
  2452.  
  2453. Cancel
  2454. ======
  2455.  
  2456.    Guess what ? It aborts the dump.
  2457.  
  2458. Telephone cost calculation
  2459. **************************
  2460.  
  2461.    Some of you own a modem but as you probably know (including me) you
  2462. can never definitly say how much the calls cost you made. That is why I
  2463. included this feature.
  2464.  
  2465.    The telephone bill calculator can be fully configured to your needs.
  2466. You can choose between three different time zones either normal or
  2467. cheap tariff for all of which you may set the duration for one unit.
  2468. KCommodity can not deal with one hundreds of a second but anyway,
  2469. inaccurances may occure while counting the time because of intolerances
  2470. (somewhat of about 1/100 seconds is not that bad I guess and fixing
  2471. that problem would have caused some more trouble). Maybe there will be
  2472. a better possibility to enter the time.  You can enter the "cost" for
  2473. one unit (without that it really would not make much sense). The input
  2474. is made in somewhat like cents, Pfennige, say in micros, but I think
  2475. that is sufficient, since there might not be an currency which counts
  2476. in millis. Furthermore you can define the times for normal and cheap
  2477. tariffs. KCommodity will check the actual system time to see which of
  2478. the two tariffs should be used. Weekdays on which cheap tariff should be
  2479. used the whole day may be marked, too.
  2480.  
  2481.    As soon as the program detects a Carrier, that means if the modem
  2482. establishes a connection to a BBS, KCommodity will start to count the
  2483. time.  You can tell the program to open up the Bill window on a Carrier
  2484. Detect. Data about the phone call may be written to a log file, so that
  2485. it can be analysed later and you can get an overview of arisen costs.
  2486. KCommodity also aids you in listing the data. The program will print
  2487. out all entries of the log file giving a total summary after the
  2488. listing of one day and a final sum after all entries have been listed.
  2489. This printout may be redirected to a file or you can view it in a
  2490. window.
  2491.  
  2492.    As mentioned above I do not take any responsibility for the correct
  2493. working of the telephone bill calculation, because slight inaccuracies
  2494. may occure within the system`s timer. Additionaly it is of importance
  2495. that you enter almost perfect times, because KCommodity`s results are
  2496. only as good as your inputs are. This function has only been
  2497. implemented to have a rough overview of costs.
  2498.  
  2499.    References: BillPrefs, BillWin
  2500.  
  2501. Revision Control System
  2502. ***********************
  2503.  
  2504.    This really is a fine feature. It might be interesting for the
  2505. programmers of you, which are working on bigger, or even on smaller,
  2506. projects. While working on a program it might be nice to see which
  2507. changes were made to a program from this to that version. Inserting
  2508. this data by hand is not quite that what I call simple. This is where
  2509. KCommodity`s  Revision Control System gets to work. This feature aids
  2510. you in inserting good looking Revision headers directly into your
  2511. sourcecode. All you have to do is to tell KCommodity the program`s name
  2512. to be revised, what kind of sourcecode it is and what information
  2513. KCommodity should insert into the Revision header. For the type of
  2514. sourcecode you can choose between Assembler, Basic, `C', and Pascal /
  2515. Modula. The main layout of the header is kept but only adjusted to
  2516. perfectly fit into the desired type of sourcecode.
  2517.  
  2518.    The special thing about the function is the way it is called. The
  2519. Revision Control System can *only* be called via ARexx. That is why I
  2520. present the syntax for that call now:
  2521.  
  2522.                      REVISE Filename ASM|BAS|C|PAS
  2523.  
  2524.    As you can see all you have to do is to feed the function with the
  2525. filename and an identifier for the type of sourcecode. Having started
  2526. the Revision Control System KCommodity will first search the sourcecode
  2527. whether there already is a Revision header inserted in the specified
  2528. language. There is no need to position the header at the first line of
  2529. the source.  KCommodity will search within the first *15* lines to find
  2530. the header, giving you the possibility to add specific directives in
  2531. front of the header. So it is possible to insert text in front of the
  2532. header(1). No matter if there already is a header this search will
  2533. always be made when the Revision Control System is called. From now on
  2534. KCommodity will go different paths in manipulating the source,
  2535. depending on the existence of a header.
  2536.  
  2537.    KCommodity comes with several ARexx scripts for use with the
  2538. supported langauges and for the CygnusED and TurboText editors.
  2539.  
  2540.    Make sure that the logical directory `T:' is accessable, because
  2541. KCommodity needs that directory to temporarily store it`s work. To be
  2542. secure I advise you to make a backup of your sourcecode before you
  2543. start the Revision Control System. (One can never know)
  2544.  
  2545.    If you want the program to store your name and the name of your
  2546. `firm' within the header you will have to set two environment variables.
  2547.  
  2548.    - AUTHOR Set this variable to your name.
  2549.  
  2550.    - COMPANY Enter your firm`s name here.
  2551.  
  2552.    Now following is a small example for setting these variables:
  2553.  
  2554.                        SETENV AUTHOR "Kai Iske"
  2555.  
  2556.                       SETENV COMPANY Gunthersoft
  2557.  
  2558.    As you can see parameters which contain spaces have to be enclosed
  2559. by quotes. Insert these settings within your `s:User-StartUp' file to
  2560. have the variables available on every bootup.
  2561.  
  2562.    ---------- Footnotes ----------
  2563.  
  2564.    (1)  Some Assemblers require special information within the first
  2565. line of the source.
  2566.  
  2567. First revision of a sourcecode with the Revision Control System
  2568. ===============================================================
  2569.  
  2570.    Assuming this situation I will now point out the actions KCommodity
  2571. performs when first used on a non-revised sourcecode. A window will be
  2572. opened with the following title:
  2573.  
  2574.                         Enter a Purpose Message
  2575.  
  2576.    As the title says you are now to enter a purpose for the sourcecode
  2577. you want to revise. You have the possibility to enter 5 lines and 60
  2578. chars per line.  When you are done with the purpose message you can
  2579. enter some more specific data. You can tell KCommodity which version
  2580. number to use for the first revision. This input is made within the
  2581. integer gadgets at the bottom of the window.
  2582.  
  2583.    The integer gadget on the left is used to enter the version number.
  2584. Into the right gadget you can enter the revision number.  The gadgets
  2585. *OK* and *CANCEL* are self-explanatory. Whilst OK starts the revision
  2586. CANCEL is used to abort. The gadget Only text will be unavailable for
  2587. the first revision. Have a look at AgainRev, for more about that.
  2588.  
  2589.    Assuming that you have made all the input and started the Revision
  2590. Control System I will now describe the actions KCommodity will perform
  2591. for building the header. At first a part of the standard header will be
  2592. built.  The production will be made within `T:'. If the environment
  2593. variables are set the author`s and the `firm`s' name will be stored
  2594. within the header.  If KCommodity was not able to find one variable, or
  2595. even both of them, the corresponding fields will be set to `--- Unknown
  2596. ---'.  Furthermore the filename and the actual system date will be
  2597. inserted. The current revision will be set to the value you specified
  2598. or to the value KCommodity automaticaly uses. Now the `purpose' text
  2599. will be inserted and finally a `log message' for the current revision
  2600. will be appended to the header. This log message will be set to `---
  2601. Initial release ---' for the first revision, because it is assumable
  2602. that no changes have been made. Behind the log message KCommodity will
  2603. insert six macros, which reflect date of the revision, time of the
  2604. revision, name of the author, who made the revision, the current
  2605. revision number of the sourcecode and version/revision numbers.  Please
  2606. have a look at RevSpec, for further information. The Revision header
  2607. will be created at the start of the sourcecode, so you will have to
  2608. insert lines which have to be in front of the header, after you revised
  2609. the source.
  2610.  
  2611. Revision of an already revised sourcecode
  2612. =========================================
  2613.  
  2614.    If there already was a header within the sourcecode KCommodity will
  2615. now go the second way. Again a window will be opened which does not
  2616. visually differ from the Purpose window. The window`s title is:
  2617.  
  2618.                           Enter a Log Message
  2619.  
  2620.    You can enter a descriptive text for all changes made to the source
  2621. since the last release (Log message) here. The two integer gadgets at
  2622. the bottom of the window can be used to set the new revision number
  2623. KCommodity should continue with. KCommodity will automatically
  2624. increment the revision of the sourcecode. KCommodity will set the
  2625. integer gadgets to the next revision.  Say if the current revision is
  2626. "1.1", the gadgets will read "1.2".  You can now change the revision in
  2627. case you want to skip several evolutionary steps. Selecting *OK* you
  2628. tell KCommodity to continue whilst *CANCEL* aborts the procedure.
  2629.  
  2630.    For additional revisions the "Only text" gadget is available. This
  2631. gadget tells KCommodity to *add* the Log message to an already existing
  2632. Log message, that means only text will be added, but no changes will be
  2633. made to the revision number. Only the revision date will be changed.
  2634.  
  2635.    Did you tell KCommodity to continue (using "Ok") only important
  2636. entries will be changed within the header. The actual revision number
  2637. will be set to the new value and the log message will be inserted
  2638. before the previously entered. The log message`s header gives you
  2639. information about the author of the revision and when the changes were
  2640. made. Finally the macros behind the header will be recreated. For
  2641. further information have a look at RevSpec.  The header`s postion
  2642. within the source will be kept unchanged but the source`s length will
  2643. slightly increase. If the first of the six macros could not be found
  2644. right after the header, KCommodity assumes that you no longer want the
  2645. program to rebuild the macros and so it does not make a refresh. So if
  2646. you insert a blank line between header and macros no more changes will
  2647. be made to them.
  2648.  
  2649. The revision header`s special features
  2650. ======================================
  2651.  
  2652.    Here is a small example for the look of the header in Assembler.
  2653.  
  2654.        ;
  2655.        ; A maximum of 14 lines above the header
  2656.        ;
  2657.      ;* $Revision Header built automatically *************** (do not edit) *
  2658.      ;*
  2659.      ;* © Copyright by <COMPANY>
  2660.      ;*
  2661.      ;* File             : test
  2662.      ;* Created on       : Monday, 22.02.93  17:50:35
  2663.      ;* Created by       : <AUTHOR>
  2664.      ;* Current revision : V2.5
  2665.      ;*
  2666.      ;*
  2667.      ;* Purpose
  2668.      ;* -------
  2669.      ;*   - This is a test
  2670.      ;*
  2671.      ;* Revision V2.5
  2672.      ;* --------------
  2673.      ;* created on Monday, 22.02.93  17:50:41  by  <AUTHOR>.   LogMessage :
  2674.      ;*  -*-  changed on Monday, 22.02.93  17:50:57 by <AUTHOR>. LogMessage :
  2675.      ;*   - Additional text for revision 2.5
  2676.      ;*  -*-  created on Monday, 22.02.93  17:50:41 by <AUTHOR>. LogMessage :
  2677.      ;*   - The next revision. This will be 2.5
  2678.      ;*
  2679.      ;* Revision V1.0
  2680.      ;* --------------
  2681.      ;* created on Monday, 22.02.93  17:50:35  by  <AUTHOR>.   LogMessage :
  2682.      ;*     --- Initial release ---
  2683.      ;*
  2684.      ;**********************************************************************
  2685.      REVISION  MACRO
  2686.                dc.b "2.5"
  2687.                ENDM
  2688.      REVDATE   MACRO
  2689.                dc.b "22.02.93"
  2690.                ENDM
  2691.      REVTIME   MACRO
  2692.                dc.b "17:50:57"
  2693.                ENDM
  2694.      AUTHOR    MACRO
  2695.                dc.b "<AUTHOR>"
  2696.                ENDM
  2697.      VERNUM    EQU  2
  2698.      REVNUM    EQU  5
  2699.        ;
  2700.        ; This is where your sourcecode would start at
  2701.        ;
  2702.  
  2703.    This is the header of an Assembler sourcecode which was revised once
  2704. after it was created. The field <COMPANY> will be filled with the name
  2705. of the company (if present). The <AUTHOR> fields will be filled with
  2706. the name of the author as long as the environment variable could be
  2707. found. At the end of the header you find six macros. These macros
  2708. reflect the actual revision number, date of revision, time of revision,
  2709. the name of the author having done the revision and version/revision
  2710. number. You can use these macros within your sourcecode, so that you
  2711. can tell the user something about the program`s "evolution" during
  2712. runtime.
  2713.  
  2714.    The Basic, `C' and Pascal / Modula pendants take the same names as in
  2715. Assembler. The `C' type macros will be set as *#defines* into the
  2716. sourcecode. As you might believe the Basic "versions" are string
  2717. variables which have a *$* postpended.
  2718.  
  2719.    There is one thing to remember while using the Pascal / Modula
  2720. macros: To make these macros available within sourcecodes I chose the
  2721. possibility to declare the macros as *CONST*ants. Therefore the *CONST*
  2722. symbol will immediatly follow the header and then following are the
  2723. macros. So you will have to add any other constant declarations *after*
  2724. KCommodity`s.
  2725.  
  2726. The ARexx Port
  2727. **************
  2728.  
  2729.    KCommodity is equipped with an ARexx Port. You can manipulate almost
  2730. all functions via the ARexx port. The name for the ARexx Port is
  2731. `KComm.1'.  So if you want to send commands to that port you would have
  2732. to issue
  2733.  
  2734.                            ADDRESS 'KComm.1'
  2735.  
  2736.    within your ARexx script to get contact with KCommodity. If you
  2737. changed the name of the port using the PORTNAME ToolType you would have
  2738. to insert the name you used, of course (see ToolTypes, for more).
  2739.  
  2740.    Please remember that string parameters for KCommodity`s commands
  2741. should be enclosed by quotes, because it could come to errors while
  2742. interpreting the command.
  2743.  
  2744.    See ARexxComs.
  2745.  
  2746. Commands for the ARexx Port
  2747. ===========================
  2748.  
  2749.    Here is a list of commands for the ARexx port.
  2750.  
  2751. `ACTIVATE 1|0'
  2752.      Turns "Window activate" function on / off.
  2753.  
  2754. `SUNMOUSE 1|0'
  2755.      Turns "Sun Mouse" on / off.
  2756.  
  2757. `SETENV 1|0'
  2758.      Turn on / off environment variables.
  2759.  
  2760. `MENUWRAP 1|0'
  2761.      Using this command, you can turn on/off "MenuWrap"
  2762.  
  2763. `FKEYS 1|0'
  2764.      If your function key settings conflict with those of an
  2765.      application, you may turn them on/off using this command.
  2766.  
  2767. `ESCCLOSE 1|0'
  2768.      The "ESC Window Close" function can be turned on / off via ARexx,
  2769.      too.
  2770.  
  2771. `MAPUMLAUT 1|0'
  2772.      Turn on / off Map "Umlauts" via ARexx.
  2773.  
  2774. `PAGENUM 0-5'
  2775.      Choice of a `page' which should be displayed within the Workbench
  2776.      titlebar or the status window. The number`s meaning is as follows:
  2777.        1. Time display plus mouse coordinates.
  2778.  
  2779.        2. Display free Chip / Fast memory.
  2780.  
  2781.        3. Numerically display total free memory.
  2782.  
  2783.        4. Timedisplay in conjunction with memory display.
  2784.  
  2785.        5. Display total free memory as a gauge.
  2786.  
  2787.        6. Online time.
  2788.  
  2789. `SCREENTIME Time'
  2790.      Set a new time for the Screen Blanker. These values are treated the
  2791.      same way as mentioned under "Screen time". This value is created
  2792.      using the following formula: Time = (Hours*60)+Minutes.
  2793.  
  2794. `MOUSETIME Time'
  2795.      Use this command to set a new time for the Mouse Blanker. These
  2796.      values are treated the same way as described under "Mouse time".
  2797.      You calculate the Time the same way as described under
  2798.      "SCREENTIME".
  2799.  
  2800. `CYCLING 1|0'
  2801.      This command is used to turn on / off "Cycling".
  2802.  
  2803. `LOGCALLS 1|0'
  2804.      The saving of data as described under "Log call" can be turned on
  2805.      / off.
  2806.  
  2807. `BILLPOPUP 1|0'
  2808.      Turning on / off the "PopUp Bill window" function.
  2809.  
  2810. `TIMEZONE 0-2'
  2811.      Change the timezone for a call via ARexx. Simply supply the
  2812.      timezone you wish to use, ranging from 0 to 2.
  2813.  
  2814. `DRIVE 0-3'
  2815.      Select a new drive to be the source for the Formatter.
  2816.  
  2817. `LABEL 'Name''
  2818.      Define a new label for disks being formated using KCommodity.
  2819.  
  2820. `TRASHCAN 1|0'
  2821.      Control the creation of the Trashcan.
  2822.  
  2823. `QUICK 1|0'
  2824.      Quick formatting may be turned on and off via ARexx.
  2825.  
  2826. `FFS 1|0'
  2827.      You can choose between OFS and FFS to be used for formatting disks.
  2828.  
  2829. `NOVERIFY 1|0'
  2830.      If it takes too long to format a disk using Verify you can turn off
  2831.      Verify for the 'Olsen' Formatter.
  2832.  
  2833. `INSTALL 1|0'
  2834.      Since Bootdisks have to be installed you can tell 'Olsen`s'
  2835.      Formatter to install the disk after the format.
  2836.  
  2837. `EJECT 1|0'
  2838.      Eject the disk after the format.
  2839.  
  2840. `INTERNATIONAL 1|0'
  2841.      This flag will set the International Mode flag for formatting.
  2842.  
  2843. `DIRCACHE 1|0'
  2844.      Using this command you may turn on directory caching mode for
  2845.      formatting a disk.
  2846.  
  2847. `WATCHDISKS 1|0'
  2848.      Tell KCommodity to check any inserted disks, or you may turn off
  2849.      this feature.
  2850.  
  2851. `FORMAT'
  2852.      Start to format a disk using the supplied settings.
  2853.  
  2854. `ENABLE'
  2855.      Does the same as mentioned under "Enable".
  2856.  
  2857. `DISABLE'
  2858.      Same as for "Disable".
  2859.  
  2860. `REVISE'
  2861.      Activate the "Revision Control System". Have a look at the
  2862.      corresponding chapter for further information.
  2863.  
  2864. Error codes
  2865. ***********
  2866.  
  2867. `x could not be opened.'
  2868.      This error code tells you that a required library or device could
  2869.      not be opened. Make sure that the desired file is located at the
  2870.      correct place (Libraries within LIBS: and devices within DEVS:).
  2871.      It is best to always use the latest resources.
  2872.  
  2873. `Broker-Port could not be created.'
  2874.      The port for communicating with Exchange and for controlling the
  2875.      main functions could not be installed. It might help you to close
  2876.      some windows and to stop several programs, because a lack of
  2877.      memory could be the reason for this error.
  2878.  
  2879. `Broker could not be set up.'
  2880.      The program`s main control structure could not be installed. Again
  2881.      a lack of free memory could be the reason.
  2882.  
  2883. `Broker could not be set up correctly.'
  2884.      The program`s main interface could not be set up. The difference
  2885.      between this error and the one mentioned above is that the system
  2886.      did not understand a definition within the structure.
  2887.  
  2888. `Sorry, memory for InputRequest could not be allocated.'
  2889.      Memory for the InputRequest could not be allocated. Try to free
  2890.      memory and restart the program.
  2891.  
  2892. `Sorry, MessagePort for InputRequest could not be created.'
  2893.      A Message Port could not be installed. Without this port the
  2894.      InputHandler can not be installed. Again the reason might be lack
  2895.      of memory.
  2896.  
  2897. `Sorry, InputHandler could not be installed.'
  2898.      The main InputHandler could not be installed. It may either be
  2899.      lack of memory or a wrong structure definition. Try to free memory
  2900.      and restart the program.
  2901.  
  2902. `Could not set up ARexx-Port.'
  2903.      The ARexx Port could not be installed. Lack of memory could be the
  2904.      reason.
  2905.  
  2906. `Audio-Port could not be set up. ...'
  2907.      The Message Port for the audio device could not be generated.
  2908.      Therefore the "Key-Click" option is totally disabled now. You can
  2909.      try to restart the program, after you have stopped several
  2910.      programs.
  2911.  
  2912. `Sorry, out of memory.'
  2913.      Simple : Not enough memory to execute the desired function. Try to
  2914.      quit some programs which are not needed.
  2915.  
  2916. `Sorry, could not generate BitMap.'
  2917.      The BitMap structure for the time display within the Workbench
  2918.      titlebar could not be initialized. The reason for this error
  2919.      definitely is lack of memory.
  2920.  
  2921. `Sorry, could not generate RastPort.'
  2922.      Same as above. The RastPort structure for the display within the
  2923.      Workbench titlebar could not be initialize.
  2924.  
  2925. `Could not allocate memory for BitPlanes.'
  2926.      The BitPlanes for the Workbench titlebar display could not be
  2927.      allocated.  Make sure that programs running are not consuming too
  2928.      much Chip memory and stop them in this case.
  2929.  
  2930. `Could not set appropriate font.'
  2931.      The font for Workbench titlebar display could not be set. This
  2932.      error should *never* occure due to the fact that the Workbench is
  2933.      already using this font (but one can never know).
  2934.  
  2935. `Could not allocate memory for ARexx-Buffer.'
  2936. `Could not allocate memory for Audio-Request.'
  2937. `Could not allocate memory for Console-Request.'
  2938.      Again there is not enough memory. Try to free memory and restart
  2939.      the program.
  2940.  
  2941. `User HotKey ... could not be set up ...'
  2942.      One of the user-defined HotKeys for the several functions could
  2943.      not be installed. The program will take the default HotKey now.
  2944.      Check your HotKey definitions.
  2945.  
  2946. `Default HotKey ... could not be set up ...'
  2947.      A default HotKey could not be installed. The attempt failed and
  2948.      the program quits. Try to free memory.
  2949.  
  2950. `Sorry, but the AppIcon could not be installed.'
  2951.      The AppIcon could not be displayed. This can happen if there is not
  2952.      sufficient memory or the Workbench is not present.
  2953.  
  2954. `Sorry, but the AppMenuItem could not be installed.'
  2955.      Same as above, but the AppMenuItem could not be installed this
  2956.      time.
  2957.  
  2958. `The Preferences-File you attempted to load...'
  2959.      You tried to load a Preferences file which was not generated using
  2960.      this version of KCommodity.
  2961.  
  2962. `Could not allocate IFF-Handle for access to file.'
  2963.      KCommodity was not able to allocate a needed structure, in order
  2964.      to obtain access to an IFF-File. Try to free some memory.
  2965.  
  2966. `Could not allocate User Task-Signal.'
  2967.      A needed task signal could not be allocated. Try to start
  2968.      KCommodity again, or make a reset, because this error code should
  2969.      *never* occure.
  2970.  
  2971. `Shared IDCMP-Port for windows could not be allocated.'
  2972.      Because of the number of windows KCommodity controls, there is
  2973.      need for a single port, all IDCMP messages go through. This Port
  2974.      has to be allocated by the application. If you discover this error
  2975.      message, a lack of memory might be the problem.
  2976.  
  2977. `Could not allocate Port for trackdisk.device'
  2978.      The MessagePort for the trackdisk.device could not be allocated.
  2979.      This device serves for checking inserted disks. Try to free some
  2980.      memory.
  2981.  
  2982.